Zum Inhalt springen

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.

GET /api/v1/document-operations/capabilities
GET /api/v1/artifacts/convert/capabilities

Diese 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.

POST /api/v1/document-operations
Idempotency-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, wird 402 zurü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=25
POST /api/v1/document-operations/{operation_id}/cancel

Nach Abschluss kann die Antwort output_document_id in die Dateibibliothek oder einen anderen Auftrag überführt werden, und credit_operation_id liefert den Abrechnungsdatensatz.

POST /api/v1/file-tools/pdf/merge
POST /api/v1/file-tools/pdf/split
POST /api/v1/file-tools/pdf/compress

Beispiel für eine Zusammenführung:

{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}

Beispiel für Aufteilung:

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}
POST /api/v1/file-tools/image/convert
POST /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.