Errors

Errors use a consistent JSON shape.
{
  "status": 403,
  "detail": "API token is paused.",
  "error_code": "auth.token_paused",
  "extra": {
    "token_id": "00000000-0000-0000-0000-000000000000"
  }
}

Fields

FieldTypeDescription
statusintegerHTTP status code
detailstringHuman-readable error
error_codestringStable machine-readable code
extraobject or nullAdditional context

Common statuses

StatusMeaning
401Missing or invalid API token
403Expired, paused, revoked token, or missing scope
429Request limit exceeded
422Request validation failed
502Upstream provider returned an invalid response
503Service temporarily unavailable
500Unexpected server error

Service unavailable

{
  "status": 503,
  "detail": "Service is temporarily unavailable.",
  "error_code": "service.unavailable",
  "extra": null
}