Strumenti per documenti e file
OmniDoc offre strumenti per file sincroni e operazioni documentali asincrone tracciabili. Richiamare innanzitutto gli endpoint delle funzionalità; non codificare in modo rigido i formati supportati o i limiti nel client.
Rilevamento delle capacità
Sezione intitolata “Rilevamento delle capacità”GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesQuesti restituiscono le operazioni attualmente aperte, i relativi formati di input, limiti di fatturazione e limiti tecnici. Le funzionalità elencate sotto unavailable non possono essere create.
Operazioni sui documenti asincrone
Sezione intitolata “Operazioni sui documenti asincrone”POST /api/v1/document-operationsIdempotency-Key: unique-request-id{ "document_id": "4q8mx2q9z1k7p6ra", "kind": "visual_extract"}Questo endpoint richiede un Idempotency-Key. kind attualmente include:
extract: estrazione strutturata, gratuita.pdf_to_html: da PDF a online HTML, gratuito.visual_extract: estrazione strutturata visiva, addebitata per pagina (1 credito per pagina). Prima dell’avvio, il numero massimo di pagine elaborabili viene determinato dal saldo disponibile (massimo 20 pagine); se il saldo copre meno di 1 pagina, viene restituito402. Al termine, vengono addebitate le pagine effettivamente elaborate e il saldo può diventare negativo.
Query e annullamento:
GET /api/v1/document-operations/{operation_id}GET /api/v1/document-operations?limit=25POST /api/v1/document-operations/{operation_id}/cancelAl completamento, il output_document_id della risposta può essere inserito nella libreria dei file o in un altro job, mentre credit_operation_id fornisce il record di regolamento.
Strumenti PDF
Sezione intitolata “Strumenti PDF”POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /api/v1/file-tools/pdf/compressEsempio di unione:
{"document_ids":["4q8mx2q9z1k7p6ra","b6t1n8c3v9m2x5ka"]}Esempio di divisione:
{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}Strumenti per immagini
Sezione intitolata “Strumenti per immagini”POST /api/v1/file-tools/image/convertPOST /api/v1/file-tools/image/compress{ "document_id": "4q8mx2q9z1k7p6ra", "target_format": "webp", "quality": 85}Gli strumenti accettano solo documenti di proprietà dell’account corrente e del tipo corrispondente. Trasmetti le risposte binarie in streaming e recupera il nome e il tipo del file dalle intestazioni della risposta.