Success
Collections
Error
Validation errors
Always HTTP 422.Rate limit
Always 429.Headers
General rules
- data is never mixed with error.
- Empty collections always return an empty array.
- Messages are optional and intended for debugging or logging.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{
"data": { ... },
"message": "Optional human-readable message"
}
{
"data": [ ... ],
"pagination": { ... },
"message": "Optional message"
}
{
"error": {
"key": "ERROR_CODE",
"message": "Human-readable explanation",
"details": { }
}
}
{
"errors": [
{
"parameter": "email",
"message": "Invalid email address",
"key": "INVALID_EMAIL_ADDRESS"
}
]
}
{
"error": {
"key": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please retry after the rate limit window resets."
}
}
HTTP/1.1 429 Too Many Requests
Retry-After: 60
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1705228800
Suggestions