Salta ai contenuti

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.

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

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

POST /api/v1/document-operations
Idempotency-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 restituito 402. 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=25
POST /api/v1/document-operations/{operation_id}/cancel

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

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

Esempio di unione:

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

Esempio di divisione:

{"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
}

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.