Skip to main content
Non-success JSON responses use this envelope:
Branch on error.code, not the prose message. Validation detail is additive and does not replace the published request schema.

TypeScript handling

The error object includes HTTP status, code, message, correlation ID, details, and parsed retry-after. It does not include the bearer credential.

Retry decision

Authentication, authorization, validation, idempotency-key reuse, and resource-state errors require a caller change. Rate-limit and temporary gateway/service errors can be retried within policy. For a mutation, reuse the original idempotency key; do not manufacture a second logical action. Use the generated OpenAPI operation page to see the documented response schemas for a particular route.