Error Codes
Error format
All API errors return a JSON object with kind and message fields:
| Field | Type | Description |
|---|---|---|
kind | string | A specific error identifier in snake_case |
message | string | Actionable guidance for the user |
Common error kinds
| Kind | Status | Description |
|---|---|---|
token_missing | 401 | No auth token provided |
token_invalid | 401 | Auth token is invalid or revoked |
project_required | 403 | Endpoint requires a project-scoped key |
request_invalid | 400 | Request body failed validation |
url_required | 400 | Source URL is required |
format_unsupported | 400 | Format not supported for this task kind |
task_not_found | 404 | Task does not exist |
run_not_found | 404 | Run does not exist |
automation_not_found | 404 | Automation does not exist |
payment_required | 402 | A payment is required to continue using this service |
internal_error | 500 | Server-side error |
4xx Client Errors
400 Bad Request
The request was invalid. This is usually caused by a missing required parameter or invalid value. The kind and message fields will help identify the specific issue.
401 Unauthorized
Authentication is required. Include an API key in the Authorization header:
402 Payment Required
A payment issue exists on the account. Visit billing to resolve.
403 Forbidden
The API key is valid but does not have access to the requested resource or action.
404 Not Found
The requested resource was not found. Verify the resource ID.
405 Method Not Allowed
The HTTP method is not supported for this endpoint.
408 Request Timeout
The request took too long to complete.
429 Too Many Requests
Rate limit exceeded. Reduce the frequency of requests.
5xx Server Errors
500 Internal Server Error
An unexpected error occurred on our side. If you encounter this error, please contact support and we will look into it immediately.
502 Bad Gateway
An invalid response was received from a downstream server.
503 Service Unavailable
The server is temporarily unable to handle requests. Please try again later.