Skip to content
SENS Platform Docs

Errors

API errors will use consistent semantics across endpoints.

HTTP API errors use this response shape:

{
"error": {
"code": "VALIDATION_FAILED",
"category": "validation",
"message": "Request validation failed.",
"correlationId": "correlation-1234",
"details": {
"field": "from"
}
}
}

Error categories:

CategoryDefault codeMeaning
validationVALIDATION_FAILEDInput failed validation.
authenticationAUTHENTICATION_FAILEDAuthentication is missing or invalid.
authorizationAUTHORIZATION_FAILEDAuthenticated caller lacks permission.
not_foundRESOURCE_NOT_FOUNDRequested resource does not exist or is not visible.
conflictCONFLICTRequest conflicts with current state.
dependency_failureDEPENDENCY_FAILURERequired dependency failed or is unavailable.
decoder_failureDECODER_FAILURETelemetry decoder failed safely.
internalINTERNAL_ERRORUnexpected server-side failure.

Error responses must include safe diagnostic details and correlation context without leaking secrets or cross-tenant information.

details values are limited to strings, numbers, booleans, and null. Details must not include passwords, tokens, raw credentials, raw payloads, secret configuration values, or data from another tenant or organization.

HTTP responses should include x-correlation-id when a correlation ID is available. Clients should include that value when reporting errors to support or operations.