Error Handling

All errors follow a consistent envelope:

Code
 
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description",
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Error Codes

Handling Errors in Code

Code
 
const response = await fetch('/v1/items', {
  headers: { 'x-api-key': key },
});

if (!response.ok) {
  const { error } = await response.json();
  console.error(`[${error.code}] ${error.message} (request: ${error.request_id})`);
  // For 409 or 503, you can safely retry after a short delay
}