upstream_rate_limited

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.

{
  "ok": false,
  "error": {
    "code": "upstream_rate_limited",
    "message": "The platform is rate limiting us; retry shortly.",
    "retryable": true
  },
  "credits_charged": 0,
  "request_id": "req_0123456789abcdef01234567"
}

Retry when error.retryable is true. If a retry-after header is present, wait that many seconds. Otherwise back off. Only rate_limited and overloaded always set that header.

What to do

• Retry shortly. The code is retryable and the attempt is free.

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