Error Response Format
HTTP Status Codes
Handling Errors
Use thecode field for programmatic error handling:
Retries
For5xx errors, retry with exponential backoff. For 4xx errors, fix the request before retrying.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Error response format and status codes.
{
"error": {
"code": "USER_NOT_FOUND",
"message": "User not found",
"detail": null
}
}
| Field | Type | Description |
|---|---|---|
code | string | Machine-readable error code for programmatic handling |
message | string | Human-readable error description |
detail | object | null | Additional context when available |
| Status | Meaning |
|---|---|
400 | Bad Request. Invalid input or validation error. |
401 | Unauthorized. Invalid or missing API key. |
403 | Forbidden. Valid API key but insufficient permissions. |
404 | Not Found. Resource does not exist. |
409 | Conflict. Resource already exists or state conflict. |
429 | Too Many Requests. Rate limit exceeded. See Rate Limiting. |
500 | Internal Server Error. Contact support if persistent. |
code field for programmatic error handling:
if (response.error.code === 'USER_NOT_FOUND') {
// Handle missing user
} else if (response.error.code === 'DUPLICATE_PHONE_NUMBER') {
// Handle duplicate phone
}
5xx errors, retry with exponential backoff. For 4xx errors, fix the request before retrying.