API
Fehler
Fehlerformat und HTTP-Statuscodes der API.
Fehlerantworten haben dasselbe JSON-Format auf allen Endpunkten:
{
"error": "Unauthorized",
"message": "Invalid API key"
}error ist ein kurzer Identifier (z. B. "Unauthorized", "Not Found", "Too Many Requests") — nützlich fürs Logging, aber nicht stabil über Versionen. Verlasse dich für Logik auf den HTTP-Statuscode, für Anzeige auf message.
Verhalten
- 4xx (Client-Fehler) —
messageenthält eine konkrete Beschreibung. Korrigiere den Request. - 5xx (Server-Fehler) — bei unerwarteten Fehlern ist
messagegenerisch ("Internal server error"). Mit Backoff erneut versuchen. Sollte der Fehler weiterhin auftreten, sende bitte eine Fehlermeldung an den Support.
Statuscodes
| Code | Bedeutung |
|---|---|
400 | Ungültige Parameter oder Validierungsfehler |
401 | API-Schlüssel fehlt oder ist ungültig |
403 | Schlüssel hat keinen Zugriff auf die angefragte Ressource |
404 | Ressource nicht gefunden |
409 | Ressource ist nicht in einem Zustand für diesen Request (z. B. OCR noch nicht fertig) |
429 | Rate-Limit überschritten — siehe Rate-Limits |
500 | Interner Fehler |
Welche Codes pro Endpunkt möglich sind, dokumentiert die OpenAPI-Referenz.
Retry-Strategie
429 und 5xx mit Exponential-Backoff erneut versuchen (z. B. 1s, 2s, 4s, max 30s). Bei 429 den retry-after-Response-Header respektieren.