Solia Direct DocsControl Plane
⌘K

API ReferenceReference

Errors

Error envelope, status codes and retryability.

Machine-readable OpenAPI description

Error shape

Errors are returned in a consistent envelope carrying an error code, a human-readable message, optional details and the request identifier, so a failure can be correlated with server-side records.

Codes and statuses

  • invalid_request — HTTP 400.
  • unauthorized — HTTP 401.
  • forbidden — HTTP 403.
  • not_found — HTTP 404.
  • conflict — HTTP 409.
  • unprocessable — HTTP 422.
  • rate_limited — HTTP 429.
  • not_configured — HTTP 503.
  • server_error — HTTP 500.

An endpoint only returns the statuses listed on its reference page; no other status is part of the contract.

Retryability

  • 400, 401, 403, 404, 409 and 422 indicate a problem with the request, credential, scope, grant or state; retrying unchanged will not succeed.
  • 429 indicates rate limiting; honour Retry-After and retry with backoff.
  • 503 not_configured means the laboratory has not configured the capability; it is not a transient failure.
  • 500 may be retried with backoff and an unchanged idempotency key.