Documentation
HTTP errors — machine-readable envelope
Cross-cutting error envelope, Retry-After semantics, and code tables mirrored from internal API gateways.
Response envelope
{
"request_id": "9e3c3d5c4d3b…",
"error": {
"type": "resource_missing",
"code": "job_not_found",
"message": "Cannot locate resource job_xyz",
"doc_url": "https://mintlify.preview/docs/errors/job_not_found"
}
} Stable code values power SDK switch statements; human copy may vary.
Rate limiting
Respond with HTTP 429 and provide Retry-After seconds honoring token bucket resets. Burst credits apply per env_ id regardless of originating region.
Global maintenance
Rare full-region evacuations bubble up as HTTP 503 with type: infra_failover.
Frequently observed codes
| Code | Typical fix |
|---|---|
unsupported_media_type | PDF only today—Office conversions stay on roadmap. |
idempotency_replay_mismatch | Same key with different payloads; pick new key if intentional. |
usage_limit_exceeded | Upgrade quotas or backoff until monthly reset. |
webhook_delivery_failed_partner | Our retries exhausted because your HTTPS cert chain broke renewal. |