Leitfäden

Jede Entwurfsentscheidung hinter der API hat hier eine eigene Seite – nicht nur eine Zeile in der Referenz: asynchrones Aufgabenmodell, Webhooks, Idempotenz, Paginierung, Fehlerbehandlung, Ratenbegrenzungen, bbox (kostenpflichtiges Opt-in) und wie Kontoeinstellungen mit API-Aufrufen interagieren.

Async-Task-Modell
Wie Dokument- und Batch-Verarbeitung asynchron in der v1-API funktioniert – die Zustandsmaschine queued/processing/succeeded/failed/canceled und die Zeitstempelkette created_at/started_at/completed_at.
Webhooks
Registrieren Sie eine Callback-URL, um benachrichtigt zu werden, sobald ein Batch fertig ist, anstatt ihn abzufragen – Standard-Webhook-Signaturprüfung, Struktur des Ereignis-Payloads, Wiederholungsverhalten, das Bbox-Abschlussereignis und wie die erneute Verarbeitung eines Batches automatisch erneut benachrichtigt wird.
Idempotenz
Verwenden Sie den Idempotency-Key-Header, um Dokument-Uploads, Batch-Verarbeitung und Bbox-Trigger sicher zu wiederholen, ohne dieselbe Operation zweimal auszuführen oder zu bezahlen.
Paginierung
Listen-Endpunkte in der v1-API verwenden eine opake cursor-basierte Paginierung – keine Seitennummern – über einen next_page_token, den Sie unverändert zurückgeben und niemals selbst dekodieren oder konstruieren.
Fehlerbehandlung
Jeder v1-Fehler ist ein JSON-Objekt mit type, code, message und doc_url — diese Seite dokumentiert die vollständige Taxonomie der Fehlertypen und jeden einzelnen Fehlercode und ist genau das, worauf eine zurückgegebene doc_url verweist.
Ratenbegrenzungen
v1-Ratenbegrenzungen gelten pro Konto, nicht pro IP-Adresse. Jede Antwort enthält die Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset, sodass Sie sich selbst drosseln können, bevor Sie einen HTTP 429 erhalten.
Bounding Boxes (bbox)
bbox ist ein optionaler, separat abgerechneter zweiter Durchlauf, der genau lokalisiert, wo auf der Seite jeder extrahierte Wert herkommt – modellgesteuerte Koordinaten ohne Pixelprüfung, daher ist die Genauigkeit als ungefähr und nicht exakt zu betrachten.
Kontoeinstellungen und API-Verhalten
v1 liest die Einstellungen Ihrer Web-App (bbox Auto-Annotation, Aufbewahrungsrichtlinie, Qualität) direkt aus, anstatt eine separate API-Konfigurationsebene bereitzustellen – diese Seite erklärt genau, welche Einstellungen die API immer befolgt und welche Sie pro Anfrage überschreiben können.
📮 contact email: [email protected]