API-Referenz
Interaktive OpenAPI-3.1-Referenz. Endpoint anklicken zum Inspizieren des Schemas, Snippet kopieren oder Request mit eigenem Schlüssel direkt gegen die Live-API absetzen.
Basis-URL & Versionierung
Alle Endpunkte liegen unter der versionierten Basis-URL. Die maschinenlesbare OpenAPI-3.1-Spezifikation steht zum Download bereit; die interaktive Konsole unten rendert sie vollständig.
https://api.claimscan.io/v1- OpenAPI-Spec:
https://api.claimscan.io/v1/openapi.json
Authentifizierung
Jede Anfrage trägt einen API-Key als Bearer-Token. Keys gibt es als Live- und Test-Umgebung und tragen eine durch Leerzeichen getrennte Liste von Scopes (z. B. analyze, account:read). Jeder Endpunkt nennt den benötigten Scope.
Authorization: Bearer csk_live_EXAMPLE_EXAMPLE_EXAMEndpunkte
| Methode | Pfad | Scope | Beschreibung |
|---|---|---|---|
GET | /v1/ping | — | Latenz- / Liveness-Probe. |
GET | /v1/auth/whoami | — | Identität des aktuellen API-Keys: Key-ID, Umgebung, Scopes, Tenant und Plan. |
GET | /v1/account | account:read | Tenant-Plan und aktueller Abrechnungszeitraum. |
GET | /v1/account/usage | account:read | Im laufenden Zeitraum verbrauchte Analysen. |
POST | /v1/analyze | analyze | Ein Bild analysieren — gibt ein forensisches Verdikt, einen Confidence-Score und eine geordnete Befundliste zurück. |
Idempotenz
Sende einen Idempotency-Key-Header (frei wählbarer String ≤ 255 Zeichen) bei jedem POST. Eine wiederholte Anfrage mit demselben Key gibt das ursprüngliche Ergebnis zurück; ein anderer Body unter demselben Key liefert 409.
Fehler-Katalog
400— Ungültige Anfrage (fehlende/kaputte Bilddaten).401— Fehlender oder ungültiger API-Key.402— Monatskontingent erschöpft (quota_exceeded).403— Key hat den geforderten Scope nicht (insufficient_scope).409— Idempotency-Key mit anderem Body wiederverwendet.413— Bild größer als das Upload-Limit.422— Dekodiertes Bild > 100 MP (Decompression-Bomb-Schutz).429— Rate-Limit überschritten — RateLimit-*-Header tragen das Budget.
Rate-Limits
Pro API-Key und Minute, je nach Plan. Überschreitungen liefern 429 mit RateLimit-*-Headern.
| Plan | Anfragen / Minute |
|---|---|
| Free | 10 |
| Solo | 30 |
| Starter | 60 |
| Growth | 300 |
| Enterprise | 1000 |
Interaktive Konsole
Die vollständige, immer aktuelle Referenz mit „Try it“-Konsole lädt direkt unter diesem Abschnitt aus der Live-OpenAPI-Spezifikation.