Error Envelope

Unified platform error schema and common codes

Unified Schema

{
  "error": {
    "request_id": "uuid",
    "provider_id": "u1|u2",
    "status": 402,
    "code": "INSUFFICIENT_CREDITS",
    "message": "human readable",
    "upstream_status": 502
  }
}

Common Codes

UNAUTHORIZED
INSUFFICIENT_CREDITS
UPSTREAM_ERROR
UPSTREAM_TIMEOUT
UPSTREAM_UNAVAILABLE
REQUEST_TOO_LARGE
UPSTREAM_RESPONSE_TOO_LARGE
ENDPOINT_NOT_SUPPORTED
AUTH_BACKEND_UNAVAILABLE
BILLING_UNAVAILABLE

Privacy Rule

Error message must not leak upstream hostnames, brands, or tokens.

Table of Contents