Error

Envelope único de erro. Programe contra type, que é estável — message é escrito para humanos e pode mudar de redação.

error object

messagestring

Frase legível descrevendo a falha.

Example: Invalid request payload.

typestring

Código estável da falha, em snake_case.

Example: invalid_request

request_idstring

Só no 500 internal: o identificador da requisição, o mesmo do header X-Request-Id. O corpo nunca traz a causa da falha — é por esse id que o suporte a encontra nos nossos registros.

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

issuesobject[]

Detalhamento por campo, quando a falha é de validação.

metaobject

Corpo de erro original da Meta, quando a falha veio dela.

scopestring

Só no 429: qual balde recusou — key, session ou account.

Possible values: [key, session, account]

allowedstring[]

Só no 405: os métodos que o caminho aceita, os mesmos do header Allow.

Error

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