Skip to main content
Check the HTTP status before reading JSON or saving export bytes. Errors on documented public endpoints use this shape:
Request validation errors return 422 with detail.error.code: "validation_error" and an additional fields array inside detail.error, identifying field locations and messages. Responses include an X-Request-ID for support. Errors from an upstream proxy may have a different body; always check HTTP status first. Deployment not enabled: 503 workspace_not_enabled means Team routing is not enabled on the server you called. Check the base URL in API Access and contact support with X-Request-ID; a new key or repeated submission will not fix it. Rate-limited API-key responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (Unix seconds). Honor Retry-After on 429 and use exponential backoff with jitter for transient failures. Retry generation with its original idempotency key. Generation uses your account’s credits. See the OpenAPI specification for request schemas and the interactive reference to try requests.

Report a failure

Include the HTTP status, detail.error.code, X-Request-ID, job or batch ID, and the failed operation. For an accepted job, also include job.error and failure_stage when available. Do not send API keys or private download URLs. A successful HTTP poll can report a failed job: check both HTTP and job status. See Track, cancel & retry for safe recovery.