Errors

All errors return the same body:

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "Project prj_01xxxxxxxxxxxxxxxxxxxxxx not found."
  }
}

code is stable and machine-readable; message is not. On validation errors, error.param names the offending field.

Status	`error.type`	Meaning
`400`	`invalid_request_error`	Required fields are missing or invalid, or no prepaid credits are available (`code` `payment_required`). API usage draws on your workspace’s prepaid credits only; a workspace admin on a Pro or Team plan can add them in Settings → Billing.
`401`	`authentication_error`	The key is missing, malformed, revoked, or expired. Check the `Authorization` header and the key’s status in Settings → API Keys.
`403`	`permission_error`	The key is valid but lacks permission. A key acts with your permissions, in its own workspace.
`404`	`invalid_request_error`	The project, task, or file id does not exist in this workspace.
`422`	`invalid_request_error`	The request body failed validation. `error.param` names the field.
`429`	`rate_limit_error`	Too many requests (see Rate limits), or too many tasks running at once (`code` `too_many_running_tasks`).
`5xx`	`api_error`	Server error.

Guides

Recipes

API reference