Error response shape
| Field | Type | Description |
|---|---|---|
code | string | Machine-readable error code |
message | string | Human-readable description |
status | integer | HTTP status code |
request_id | string | Correlation ID, also returned in the X-Request-Id header. Include it when reporting a failure. |
field | string | Present on 422 errors: the parameter that failed validation. |
retry_after | integer | Present on 429 and 503: seconds to wait before retrying (also the Retry-After header). |
Error codes
| Status | Code | Description |
|---|---|---|
| 400 | bad_request | Invalid request parameters (some endpoints return a more specific code, e.g. invalid_params) |
| 401 | unauthorized | Invalid or missing API key |
| 403 | forbidden | Insufficient permissions |
| 404 | not_found | Resource not found |
| 409 | conflict | Resource already exists (e.g. duplicate API key) |
| 422 | validation_error | Request validation failed; field names the offending parameter |
| 429 | rate_limit_exceeded | Rate limit exceeded (check Retry-After) |
| 503 | service_unavailable | A dependency is temporarily unavailable; retry after Retry-After |