Nástroje pro dokumenty a soubory
OmniDoc nabízí synchronní nástroje pro práci se soubory a sledovatelné asynchronní operace s dokumenty. Nejprve vyvolávejte koncové body funkcí; neuvádějte pevně zakódované podporované formáty ani limity v klientu.
Zjišťování schopností
Section titled “Zjišťování schopností”GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesTyto položky vracejí aktuálně otevřené operace, jejich vstupní formáty, fakturační a technické limity. Funkce uvedené pod unavailable nelze vytvořit.
Asynchronní operace s dokumenty
Section titled “Asynchronní operace s dokumenty”POST /api/v1/document-operationsIdempotency-Key: unique-request-id{ "document_id": "4q8mx2q9z1k7p6ra", "kind": "visual_extract"}Tento koncový bod vyžaduje Idempotency-Key. kind aktuálně zahrnuje:
extract: strukturovaná extrakce, zdarma.pdf_to_html: PDF na online HTML, zdarma.visual_extract: vizuální strukturovaná extrakce, účtováno za každou stránku (1 kredit za stránku). Před zahájením je zastavení počtu stran, které může zpracovat, nastaveno ze zůstatku (maximálně 20 stran); pokud zůstatek pokrývá méně než 1 stránku, vrátí se402. Po dokončení jsou účtovány skutečně zpracované stránky a zůstatek se může stát záporným.
Dotazování a zrušení:
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 output_document_id odpovědi přejít do knihovny souborů nebo do jiného úlohy a credit_operation_id poskytuje záznam o vypořádání.
Nástroje PDF
Section titled “Nástroje PDF”POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressPříklad slučování:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}Příklad rozdělení:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}Nástroje pro obrázky
Section titled “Nástroje pro 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í pouze dokumenty, které vlastní aktuální účet a jejichž typ odpovídá. Streamujte binární odpovědi a získávejte název souboru a jeho typ z hlaviček odpovědi.