Getting Started

Response Format

All v1 responses use a consistent JSON envelope.

Success

{
  "ok": true,
  "data": { },
  "meta": { "request_id": "uuid" }
}

Error

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Invalid credentials",
    "request_id": "uuid"
  },
  "meta": { "request_id": "uuid" }
}

Use error.code for programmatic handling and meta.request_id when contacting support. error.details (and retryable, retry_after, provider_code when relevant) appear only when there is extra context; they are omitted otherwise. Errors raised by the authentication layer (for example 401 credentials errors and 429 rate limits) carry meta.request_id but no error.request_id.