Dokument- und Dateiwerkzeuge
OmniDoc bietet synchrone Dateiwerkzeuge und nachverfolgbare asynchrone Dokumentoperationen. Rufen Sie zuerst die Funktionsendpunkte auf; kodieren Sie unterstützte Formate oder Limits nicht fest im Client.
Fähigkeitsentdeckung
Abschnitt betitelt „Fähigkeitsentdeckung“GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesDiese geben die derzeit geöffneten Operationen, deren Eingabeformate sowie Abrechnungs- und technische Grenzwerte zurück. Unter unavailable aufgeführte Funktionen können nicht erstellt werden.
Asynchrone Dokumentoperationen
Abschnitt betitelt „Asynchrone Dokumentoperationen“POST /api/v1/document-operationsIdempotency-Key: unique-request-id{ "document_id": "4q8mx2q9z1k7p6ra", "kind": "visual_extract"}Dieser Endpunkt erfordert einen Idempotency-Key. kind umfasst derzeit:
extract: strukturierte Extraktion, kostenlos.pdf_to_html: PDF zu online HTML, kostenlos.visual_extract: Visuelle strukturierte Extraktion, abgerechnet pro Seite (1 Credit pro Seite). Vor Beginn wird die maximale Anzahl der verarbeitbaren Seiten anhand des Guthabens festgelegt (höchstens 20 Seiten); deckt das Guthaben weniger als 1 Seite ab, wird402zurückgegeben. Nach Abschluss werden die tatsächlich verarbeiteten Seiten abgerechnet, wodurch das Guthaben auch negativ werden kann.
Abfrage und Stornierung:
GET /api/v1/document-operations/{operation_id}GET /api/v1/document-operations?limit=25POST /api/v1/document-operations/{operation_id}/cancelNach Abschluss kann die Antwort output_document_id in die Dateibibliothek oder einen anderen Auftrag überführt werden, und credit_operation_id liefert den Abrechnungsdatensatz.
PDF Werkzeuge
Abschnitt betitelt „PDF Werkzeuge“POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressBeispiel für eine Zusammenführung:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}Beispiel für Aufteilung:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}Bildwerkzeuge
Abschnitt betitelt „Bildwerkzeuge“POST /api/v1/file-tools/image/convertPOST /api/v1/file-tools/image/compress{ "document_id": "4q8mx2q9z1k7p6ra", "target_format": "webp", "quality": 85}Die Tools akzeptieren ausschließlich Dokumente, die dem aktuellen Konto gehören und deren Typ übereinstimmt. Streamen Sie binäre Antworten und entnehmen Sie Dateiname und Typ den Antwort-Headern.