Nástroje pre dokumenty a súbory
OmniDoc ponúka synchronické nástroje na prácu so súbormi a sledovateľné asynchrónne operácie s dokumentmi. Najprv volajte koncové body funkcií; neimplementujte podporované formáty alebo limity pevne v kliente.
Zistenie schopností
Section titled “Zistenie schopností”GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesTieto položky vrátia aktuálne otvorené operácie, ich vstupné formáty, fakturačné a technické limity. Funkcie uvedené pod unavailable nie je možné vytvoriť.
Asynchrónne operácie s dokumentmi
Section titled “Asynchrónne operácie s dokumentmi”POST /api/v1/document-operationsIdempotency-Key: unique-request-id{ "document_id": "4q8mx2q9z1k7p6ra", "kind": "visual_extract"}Tento koncový bod vyžaduje Idempotency-Key. kind aktuálne zahŕňa:
extract: štruktúrovaná extrakcia, zadarmo.pdf_to_html: PDF na online HTML, zadarmo.visual_extract: vizuálna štruktúrovaná extrakcia, účtovaná za každú stranu (1 kredit za stranu). Pred spustením sa nastaví počet strán, ktoré môže spracovať, z zostatku (maximálne 20 strán); ak zostatok pokrýva menej ako 1 stranu, vráti402. Po dokončení sa účtujú skutočne spracované strany a zostatok môže byť aj záporný.
Dotaz a zrušenie:
GET /api/v1/document-operations/{operation_id}GET /api/v1/document-operations?limit=25POST /api/v1/document-operations/{operation_id}/cancelPo dokončení môže byť output_document_id odpovede uložený do knižnice súborov alebo do iného úlohy a credit_operation_id poskytuje záznam o vysporiadaní.
PDF tools
Section titled “PDF tools”POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressPríklad zlučovania:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}Príklad rozdelenia:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}Nástroje na obrázky
Section titled “Nástroje na obrázky”POST /api/v1/file-tools/image/convertPOST /api/v1/file-tools/image/compress{ "document_id": "4q8mx2q9z1k7p6ra", "target_format": "webp", "quality": 85}Nástroje akceptujú iba dokumenty, ktoré vlastní aktuálny účet a ktorých typ sa zhoduje. Streamujte binárne odpovede a názov súboru a typ získajte z hlavičiek odpovede.