API-Dokumentation

Fehler

Alle Fehler haben dieselbe Form. Verzweigen Sie Ihre Logik über code, niemals über message.

Form

400 Bad Request

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid parameter `limit`: Number must be less than or equal to 100"
  }
}

code ist stabil und Teil des Vertrags. message richtet sich an den Menschen bei der Fehlersuche: Der Text kann jederzeit umformuliert, übersetzt oder präzisiert werden. Ein Client, der die Meldung auswertet, bricht bei der ersten Tippfehlerkorrektur.

Codes

Codes
Code	Status	Bedeutung
`invalid_request`	400	Ein Parameter hat die Prüfung nicht bestanden. Die Meldung nennt ihn.
`invalid_cursor`	400	Der Cursor ist unlesbar. Geben Sie `page.nextCursor` unverändert zurück.
`unauthorized`	401	Es wurde kein Schlüssel gesendet, oder der Header hat nicht die Form `Bearer`.
`invalid_key`	401	Der Schlüssel ist fehlerhaft oder unbekannt.
`key_revoked`	401	Der Schlüssel existierte, wurde aber widerrufen. Erstellen Sie einen neuen.
`insufficient_scope`	403	Der Schlüssel trägt nicht die für diesen Vorgang nötige Berechtigung.
`account_suspended`	403	Das Konto ist gesperrt und kann die API nicht nutzen.
`cors_not_supported`	403	Aufruf aus einem Browser-Ursprung. Diese API wird von einem Server aus aufgerufen.
`not_found`	404	Die Ressource existiert nicht oder ist nicht öffentlich.
`rate_limited`	429	Ratenbegrenzung erreicht. Siehe `Retry-After`.
`internal_error`	500	Fehler auf unserer Seite. Er wurde protokolliert.
`query_unavailable`	503	Die Abfrage kann derzeit nicht bedient werden — ein Speicherindex wird gerade aufgebaut. Bitte erneut versuchen.

Was sich zu wiederholen lohnt

429 und 503 sind vorübergehend: Wiederholen Sie den Aufruf und beachten Sie dabei Retry-After, sofern vorhanden. 400, 401, 403 und 404 sind es nicht — ein unveränderter zweiter Versuch liefert dieselbe Antwort.