Anleitung · 1 Min. Lesezeit

Fehlercodes

Jeder Fehler, den die API zurückgibt, was er bedeutet und wie du reagierst.

Fehler liefern einen Nicht-2xx-Status und einen JSON-Body mit einem stabilen, maschinenlesbaren code. Verzweige anhand des Codes, nie anhand der Meldung - Meldungen sind für Menschen geschrieben und können sich ändern.

json
{
  "success": false,
  "error": {
    "code": "insufficient_credits",
    "message": "This call costs 10 credits and your balance is 3. Top up to continue.",
    "details": null
  },
  "creditsCharged": 0,
  "creditsRemaining": 3
}

Referenz

StatusCodeBedeutung und Lösung
400invalid_argumentsEin Argument fehlt oder hat den falschen Typ. details listet jedes Problem pro Feld auf. Nicht berechnet.
400invalid_urlEin URL-Argument ist keine absolute http-/https-URL.
400invalid_hashDer übergebene Hash hat nicht das erwartete Format für diesen Algorithmus.
401unauthorizedDer Schlüssel fehlt, ist fehlerhaft oder widerrufen. Prüfe den Authorization-Header.
402insufficient_creditsDas Guthaben liegt unter dem Preis des Aufrufs. Aufladen. Es wurde nichts berechnet.
403account_suspendedDas Konto ist gesperrt. Wende dich an den Support.
404unknown_toolKein Endpunkt mit diesem Schlüssel. Prüfe die genaue Schreibweise in der Referenz.
502upstream_unreachableDer Ziel-Host hat nicht geantwortet. Berechnet - der Versuch wurde in deinem Auftrag unternommen.
502upstream_timeoutDas Ziel hat zu lange gebraucht. Erstattet.
502internal_errorEin Fehler auf unserer Seite. Erstattet. Wiederhole den Aufruf; bleibt der Fehler, kontaktiere den Support.
503tool_disabledDieser Endpunkt ist vorübergehend abgeschaltet. Nicht berechnet.

Sicher wiederholen

  • Wiederhole 502 und 503 mit exponentiellem Backoff - sie sind vorübergehend, und die erstatteten kosten nichts.
  • Wiederhole 400, 401 oder 403 nie, ohne die Anfrage zu ändern - das Ergebnis wäre identisch.
  • Behandle 402 als Stopp, nicht als Wiederholung. Schleifen darauf helfen nicht, bis sich das Guthaben ändert.
  • Jeder Endpunkt ist nur lesend oder ohne Nebenwirkungen - eine Wiederholung kann also nie bereits bezahlte Arbeit doppelt auslösen.

Bereit zum Loslegen?

Sieh dir alle Endpunkte mit Preisen an oder erstelle einen Schlüssel und mach deinen ersten Aufruf.