API Reference
Errors API
Every error code the gateway can return, and what each one means.
Envelope
All errors share one envelope. See Error Handling for the field reference.
{
"error": {
"type": "rate_limit",
"code": "rate_limit_exceeded",
"message": "Quota exceeded. Retry after 17s.",
"provider": null,
"retryable": true,
"request_id": "req_01J8..."
}
}Error types
| type | Description | retryable |
|---|---|---|
| invalid_request | Malformed body, unknown model, unsupported field. | false |
| auth | Bad or missing key. | false |
| rate_limit | Key or gateway quota exceeded. | true |
| provider | An upstream provider failed after retries. | true |
| internal | Gateway failure. | true |
HTTP status by type
| type | Typical status |
|---|---|
| invalid_request | 400 / 404 / 422 |
| auth | 401 |
| rate_limit | 429 |
| provider | 502 / 503 / 529 |
| internal | 500 |
Matching on codes
import { OpenLink, OpenLinkError } from "@openlink/sdk";
try {
await client.chat({ messages });
} catch (err) {
if (err instanceof OpenLinkError && err.code === "rate_limit_exceeded") {
// back off and retry
}
}