Skip to Content

Errors

The error envelope every non-2xx v1 response uses.

Every non-2xx response has the same JSON body:

{
  "error": {
    "code": "rate_limited",
    "message": "This API key made too many requests. Try again in 12 seconds.",
    "request_id": "0b7e4c1e-6f0a-4a57-9d5e-3f1a2b6c8d90"
  }
}
FieldMeaning
codeA stable, lowercase code. Match on this.
messageText for people. It may change, so do not match on it.
request_idThe x-request-id of the request. Quote it when you contact support.
detailsExtra fields about the refusal, when there are any.

Codes

A response uses a specific code when one applies, such as api_key_scope_forbidden (see authentication). Otherwise the code follows the status:

StatusCode
400, 422invalid_request
401unauthenticated
403forbidden
404not_found
405method_not_allowed
409conflict
413payload_too_large
429rate_limited
5xxinternal

A 5xx response always has the message Internal server error and no details. Retry it later, and quote its request_id if it keeps failing.

On this page