Skip to main content
Errors use the same envelope structure as successful responses.
{
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "Request payload is invalid",
    "details": {}
  },
  "request_id": "req_..."
}

Common status codes

StatusMeaning
400The request payload, path parameter, or query parameter is invalid.
401The caller is not authenticated or the session is invalid.
404The requested resource does not exist in the current workspace or environment.

Request IDs

Include request_id when you report API issues.

Authentication failures

Protected routes require a workspace API key in Authorization: Bearer <api_key>.

Environment mistakes

Environment-scoped routes default to sandbox. always pass environment=live explicitly when operating on live workspace resources.