PoliscopePoliscope
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)message enthält eine konkrete Beschreibung. Korrigiere den Request.
  • 5xx (Server-Fehler) — bei unerwarteten Fehlern ist message generisch ("Internal server error"). Mit Backoff erneut versuchen. Sollte der Fehler weiterhin auftreten, sende bitte eine Fehlermeldung an den Support.

Statuscodes

CodeBedeutung
400Ungültige Parameter oder Validierungsfehler
401API-Schlüssel fehlt oder ist ungültig
403Schlüssel hat keinen Zugriff auf die angefragte Ressource
404Ressource nicht gefunden
409Ressource ist nicht in einem Zustand für diesen Request (z. B. OCR noch nicht fertig)
429Rate-Limit überschritten — siehe Rate-Limits
500Interner 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.

On this page