Reference

Errors

Every failure returns the same envelope with a stable, switchable error code.

Error envelope

json

{
  "success": false,
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid or revoked API key.",
    "details": null
  },
  "meta": { "request_id": "req_9f2c1a7b3e4d5c6f" }
}

Handle failures on error.code, not the HTTP status or message — messages may change, codes will not. Include the request_id when contacting support.

Codes

Field	Type	Description
bad_request	400	Malformed request (e.g. bad path parameter).
validation_error	422	A query parameter failed validation; see error.details.
unauthorized	401	This endpoint requires an API key.
invalid_api_key	401	The presented key is missing, malformed, or revoked.
insufficient_scope	403	The key lacks a scope this endpoint requires.
not_found	404	No such resource, or it isn't publicly visible.
rate_limited	429	Too many requests; honor the Retry-After header.
feature_disabled	503	The API is paused for maintenance.
internal_error	500	An unexpected error on our end.