Dokumentum- és fájelszolgáltatók
A OmniDoc szinkron fájlszolgáltatásokat és nyomon követhető aszinkron dokumentumműveleteket kínál. Először hívja a képességi végpontokat; ne rögzítse a támogatott formátumokat vagy korlátokat a kliensben.
Képesség-felismerés
Szekció neve “Képesség-felismerés”GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesEzek a jelenleg nyitott műveleteket, azok bemeneti formátumait, számlázási és technikai korlátait adják vissza. A unavailable alatt felsorolt képességek nem hozhatók létre.
Aszinkron dokumentumműveletek
Szekció neve “Aszinkron dokumentumműveletek”POST /api/v1/document-operationsIdempotency-Key: unique-request-id{ "document_id": "4q8mx2q9z1k7p6ra", "kind": "visual_extract"}Ez a végpont Idempotency-Key-et igényel. A(z) kind jelenleg a következőket tartalmazza:
extract: strukturált kinyerés, ingyenes.pdf_to_html: PDF online HTML-ra, ingyenes.visual_extract: vizuális strukturált kinyerés, laponkénti díjszabás (laponként 1 kredit). A művelet megkezdése előtt a rendelkezésre álló egyenlegből beállítható a feldolgozható lapok száma (maximum 20 lap); ha az egyenleg kevesebb mint 1 lapra elegendő, akkor402értéket ad vissza. A művelet befejeztével a ténylegesen feldolgozott lapokat terhelik, és az egyenleg negatív értékre is csökkenhet.
Lekérdezés és törölés:
GET /api/v1/document-operations/{operation_id}GET /api/v1/document-operations?limit=25POST /api/v1/document-operations/{operation_id}/cancelAmikor befejeződik, a válasz output_document_id menthető a fájlkönyvtárba vagy egy másik feladathoz, és credit_operation_id adja a lezáró rekordot.
PDF eszközök
Szekció neve “PDF eszközök”POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressÖsszevonási példa:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}Osztás példája:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}Kézeszközök
Szekció neve “Kézeszközök”POST /api/v1/file-tools/image/convertPOST /api/v1/file-tools/image/compress{ "document_id": "4q8mx2q9z1k7p6ra", "target_format": "webp", "quality": 85}Az eszközök csak a jelenlegi fiók tulajdonában lévő, típusuknak megfelelő dokumentumokat fogadják. Küldjön vissza bináris válaszokat, és vegye fel a fájlnevet és típust a válaszfejlécekben.