Resources / Errors

Errors

The API uses conventional HTTP status codes and a single, predictable error envelope.

Error shape

Every error response carries an error object with a stable, machine-readable code and a human-readable message. Branch on the code; show or log the message.

application/json

{
  "error": {
    "code": "bad_request",
    "message": "file_url or file is required"
  }
}

Error codes

NAMETYPEDESCRIPTION

bad_request400The request was malformed or missing required parameters.

unauthorized401Missing, revoked, or invalid API key.

insufficient_credits402The organization balance is zero or negative. Top up before starting paid provider work.

forbidden403Authenticated, but not allowed — e.g. an admin-only route.

not_found404The requested resource does not exist in your organization.

rate_limited429Too many requests. Back off and retry.

internal_error500Something went wrong on our side. Safe to retry idempotent requests.

PreviousRate limits NextPlatform status