Error

The single error envelope. Program against type, which is stable — message is written for humans and its wording can change.

error object

messagestring

Human-readable sentence describing the failure.

Example: Invalid request payload.

typestring

Stable snake_case failure code.

Example: invalid_request

request_idstring

Only on 500 internal: the request's identifier, the same as the X-Request-Id header. The body never carries the cause of the failure — this id is how support finds it in our logs.

Example: 0d72872e-f70e-4c25-95c6-6bec4d33a800

issuesobject[]

Per-field detail when the failure is a validation error.

metaobject

Meta's original error body, when the failure came from them.

scopestring

Only on a 429: which bucket refused — key, session or account.

Possible values: [key, session, account]

allowedstring[]

Only on a 405: the methods the path accepts, the same as the Allow header.

Error

{
  "error": {
    "message": "Invalid request payload.",
    "type": "invalid_request",
    "request_id": "0d72872e-f70e-4c25-95c6-6bec4d33a800",
    "issues": [
      {}
    ],
    "meta": {},
    "scope": "key",
    "allowed": [
      "string"
    ]
  }
}