Skip to main content

Error envelope

Every error response follows the same shape:
  • type - a machine-readable error code (e.g., "VALIDATION_ERROR"). Use this for programmatic error handling.
  • message - a human-readable description of what went wrong.
  • request_id - a unique identifier for this request. Quote this in support requests so the team can trace your issue.

Response headers

Every response (success or error) includes:

Content-Type enforcement

All non-GET requests must include Content-Type: application/json. Requests with a different content type receive a 415 UNSUPPORTED_MEDIA_TYPE error before reaching the route handler.

Error codes

Examples

401 - Invalid API key

400 - Validation error

404 - Entity not found