Sari la conținut

Instrumente pentru documente și fișiere

OmniDoc oferă instrumente de fișiere sincrone și operații documentare asincrone urmărite. Apelați mai întâi punctele terminale ale funcționalității; nu codificați în mod fix formate sau limite suportate în client.

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

Acestea returnează operațiile actuale deschise, formatele lor de input, limitele de facturare și cele tehnice. Capacitățile listate sub unavailable nu pot fi create.

POST /api/v1/document-operations
Idempotency-Key: unique-request-id
{
"document_id": "4q8mx2q9z1k7p6ra",
"kind": "visual_extract"
}

Acest punct de terminare necesită un Idempotency-Key. kind include în prezent:

  • extract: extragere structurată, gratuită.
  • pdf_to_html: PDF către online HTML, gratuit.
  • visual_extract: extragere vizuală structurată, facturată pe pagină (1 credit per pagină). Înainte de începere, numărul maxim de pagini procesabile este stabilit din soldul disponibil (maxim 20 de pagini); dacă soldul acoperă mai puțin de o pagină, se returnează 402. La finalizare, sunt facturate paginile efectiv procesate, iar soldul poate deveni negativ.

Cerință și anulare:

GET /api/v1/document-operations/{operation_id}
GET /api/v1/document-operations?limit=25
POST /api/v1/document-operations/{operation_id}/cancel

La finalizare, output_document_id al răspunsului poate fi transferat în biblioteca de fișiere sau într-o altă sarcină, iar credit_operation_id furnizează înregistrarea de plată.

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

Exemplu de unire:

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

Exemplu de împărțire:

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

Instrumentele acceptă doar documente deținute de contul curent și a căror tip este compatibil. Trimite răspunsuri binare în flux și obține numele fișierului și tipul din capetele răspunsului.