unauthorized

The x-api-key header is missing or not a valid key.

Response

Every failure uses this envelope. credits_charged is 0. The message below is the default text for this code. Live messages can change, so branch on error.code.

HTTP 401Sample
{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "The x-api-key header is missing or not a valid key.",
    "retryable": false
  },
  "credits_charged": 0,
  "request_id": "req_0123456789abcdef01234567"
}

error.retryable is false. The same request fails the same way.

What to do

  • Send the key in x-api-key. See authentication.
  • Do not retry until the header is a live key.

The response header x-request-id matches request_id. The full list is on errors.