API reference

Errors

HTTP status codes, the error body, and when a retry helps.

Errors use real HTTP status codes and this body:

{
  "error": {
    "code": "insufficient_balance",
    "message": "Insufficient balance. Please top up your account.",
    "type": "invalid_request_error"
  }
}

type is server_error for 5xx errors and invalid_request_error otherwise.

Errors at submit time (4xx): no task is created and nothing is charged.
Failures while running: the task's status becomes failed, its error has the same code and message, and the charge is refunded in full.

HTTP	code	Meaning
400	`invalid_request`	The request body or a parameter is invalid; the message says which.
400	`route_not_offered`	The requested route does not offer this model.
400	`no_route_selected`	Your route settings leave no route for this model.
400	`price_above_max`	Every selected route costs more than your maximum price.
400	`unsupported_parameters`	No selected route supports this combination of parameters.
400	`content_policy_violation`	Content moderation refused the request.
401	`unauthorized`	The API key is missing or invalid.
402	`insufficient_balance`	Your balance is too low. Top up and try again.
402	`key_quota_exceeded`	This API key reached its spending limit.
403	`forbidden`	This key may not use this model, or not from this IP address.
403	`account_blocked`	API access for this account is suspended.
404	`model_not_found`	No such model is on sale.
404	`task_not_found`	No such task in your account.
404	`file_not_found`	No such uploaded file, or it expired.
409	`idempotency_conflict`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down.
429	`too_many_tasks`	Too many tasks are waiting. Retry later.
502	`generation_failed`	Generation failed. You were not charged.
503	`no_available_route`	No route can serve this model right now. You were not charged.
504	`timeout`	Generation timed out. You were not charged.
500	`internal_error`	Something went wrong on our side.

When to retry

429: wait a moment, then send fewer requests.
502, 503, 504: submit a new task. The failed one was refunded.
400, 402, 403, 404: fix the request, top up or change the key's settings first; retrying as is won't help.