Getting started

Errors

Error shape

All errors return a structured JSON body:

{ "error": { "type": "validation_error", "code": "invalid_field", "message": "field email is required", "field": "email", "request_id": "req_01H" } }

Status codes

  • 400 validation error
  • 401 missing or invalid API key
  • 403 your key lacks the required scope
  • 404 resource not found in this tenant
  • 409 conflict
  • 422 semantically invalid
  • 429 rate-limited; retry after Retry-After
  • 5xx transient platform error; retry with exponential backoff

Always log request_id.