Beta docs: the shipped API is POST /api/v1/generate for gemini and sarvam. Some pages below describe planned features. See the shipped quick start.

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.

JSON
{
  "error": {
    "type": "rate_limit",
    "code": "rate_limit_exceeded",
    "message": "Quota exceeded. Retry after 17s.",
    "provider": null,
    "retryable": true,
    "request_id": "req_01J8..."
  }
}

Error types

typeDescriptionretryable
invalid_requestMalformed body, unknown model, unsupported field.false
authBad or missing key.false
rate_limitKey or gateway quota exceeded.true
providerAn upstream provider failed after retries.true
internalGateway failure.true

HTTP status by type

typeTypical status
invalid_request400 / 404 / 422
auth401
rate_limit429
provider502 / 503 / 529
internal500

Matching on codes

TS
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
  }
}