API Reference
Errors
Error response format and common error codes.
Errors use the same envelope shape.
{
"success": false,
"error": {
"code": "INVALID_INPUT",
"message": "Invalid input provided"
},
"meta": {
"requestId": "018ff..."
}
}| Code | HTTP | When it happens |
|---|---|---|
INVALID_INPUT | 400 | A query parameter or body field failed validation |
INVALID_CURSOR | 400 | The cursor value is malformed or no longer valid |
UNAUTHORIZED | 401 | Missing or invalid X-API-Key |
NOT_FOUND | 404 | The requested record does not exist |
TOO_MANY_REQUESTS | 429 | Workspace rate limit exceeded — back off and retry |
PAYMENT_REQUIRED | 402 | No credits remaining on the workspace |
meta.requestId is safe to log and share with support when reporting an issue.