Common headers
All authenticated endpoints require these headers.
Example
Idempotency
All POST requests must include anX-Idempotency-Key header with a valid UUID v4.
This ensures retrying a request (for example, after a network timeout) does not create duplicate resources.
Behavior
- First request with a given key → processed normally
- Subsequent requests with the same key → the original response is replayed without re-executing the operation
- Keys are scoped per client and expire after 24 hours
- Only successful responses (
2xx) are cached - Failed requests can be retried with the same key
400 MISSING_IDEMPOTENCY_KEY-X-Idempotency-Keyis required for POST requests400 INVALID_IDEMPOTENCY_KEY-X-Idempotency-Keymust be a valid UUID
Common error responses
All error responses follow this format:401 EMPTY_AUTH_KEY- Authentication token is required403 INVALID_AUTH_TOKEN- Authentication token is invalid or expired