Understand API error responses, status codes, and best practices for debugging and recovery.
code
, message
, and optionally, details
.
Code | Meaning | Description |
---|---|---|
200 | OK | Request was successful. |
201 | Created | Resource was successfully created. |
400 | Bad Request | The request is invalid (e.g., missing fields, invalid format). |
401 | Unauthorized | Invalid or missing API key. |
403 | Forbidden | Authenticated, but not allowed to perform the operation. |
404 | Not Found | Resource not found or endpoint incorrect. |
409 | Conflict | Duplicate resource creation or logic conflict (e.g., reused idempotency key). |
429 | Too Many Requests | Rate limit exceeded. |
500 | Internal Server Error | An unexpected server-side error occurred. |
503 | Service Unavailable | Temporary downtime or overload. Try again later. |
code
and message
fields for immediate clarity on the error.request_id
when contacting support to help trace the exact call.Content-Type
is set to application/json
and all required fields are included.429 Too Many Requests
, inspect the following response headers:
Header | Description |
---|---|
X-RateLimit-Limit | Max requests per minute allowed |
X-RateLimit-Remaining | Number of remaining requests in current window |
X-RateLimit-Reset | Time (Unix epoch) when the limit resets |
request_id
from the responselive
or sandbox
)