API-Doku

Fehler

Eine Form für jeden Fehlschlag.

Bei einem Fehler ist der HTTP-Status nicht 2xx und der Body enthält genau ein error-Objekt:

json
{
  "error": {
    "message": "Insufficient credits: this request needs 60 credits. Top up and try again.",
    "type": "insufficient_quota",
    "param": null,
    "code": "insufficient_credits"
  }
}

Felder

FeldBeschreibung
messageFür Menschen gedacht, auf Englisch. Nicht darauf verzweigen – der Wortlaut ändert sich
typeGrobe Kategorie, siehe unten
codeKonkreter Grund. Hierauf verzweigen
paramName des beanstandeten Parameters, sonst null

Häufige Codes

HTTPcodeBedeutung
401missing_api_keyKein Authorization-Header oder nicht in der Form Bearer sk-xxx
401invalid_api_keyUnbekannter, deaktivierter oder gelöschter Schlüssel – bewusst nicht unterscheidbar
400invalid_requestParameterproblem, siehe message. Leerer prompt, image-Modus ohne Bild usw.
402insufficient_creditsGuthaben aufgebraucht. Aufladen und vor dem Retry /v1/credits prüfen
429rate_limit_exceededZu viele Aufrufe. Zurückfahren und erneut versuchen
429concurrency_limit_reachedParallelität oder Tageskontingent erreicht. Später erneut versuchen
404not_foundAuftrag existiert nicht oder gehört nicht zu diesem Konto
502generation_failedBei einem synchronen Aufruf sind alle Bilder fehlgeschlagen. Credits bereits erstattet
504generation_timeoutSynchroner Aufruf zeitlich abgelaufen. Der Auftrag läuft weiter und Credits werden nicht erstattet – hole ihn über /v1/tasks/{id} mit der id aus der Meldung
500internal_errorServerseitig. Wiederholbar; bei Dauer bitte melden
Ein asynchron angenommener Auftrag, der später scheitert, nutzt diese Form nicht: Der Aufruf ist 200, das Auftragsobjekt trägt status failed, und der Grund steht in error. Nur synchrone Bildaufrufe melden einen Fehlschlag als 502.