Ga naar inhoud

Document- en bestandstools

OmniDoc biedt synchrone bestandsfuncties en traceerbare asynchrone documentbewerkingen. Roep eerst de capability-endpoints aan; programmeer geen ondersteunde indelingen of limieten vast in de client.

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

Deze geven de momenteel openstaande bewerkingen, hun invoerformaten, facturering en technische limieten weer. Mogelijkheden die onder unavailable worden vermeld, kunnen niet worden aangemaakt.

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

Dit eindpunt vereist een Idempotency-Key. kind bevat momenteel:

  • extract: gestructureerde extractie, gratis.
  • pdf_to_html: PDF naar online HTML, gratis.
  • visual_extract: visuele gestructureerde extractie, per pagina gefactureerd (1 credit per pagina). Voordat de verwerking start, wordt het maximale aantal te verwerken pagina’s bepaald op basis van het saldo (maximaal 20 pagina’s); als het saldo minder dan 1 pagina dekt, retourneert het 402. Na afronding worden de daadwerkelijk verwerkte pagina’s in rekening gebracht en kan het saldo negatief worden.

Query en annuleren:

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

Wanneer het is voltooid, kan de output_document_id van het antwoord in de bestandsbibliotheek of een andere taak worden opgeslagen, en geeft credit_operation_id het afwikkelingsrecord.

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

Voorbeeld van samenvoegen:

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

Voorbeeld van splitsen:

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

De tools accepteren alleen documenten die eigendom zijn van het huidige account en waarvan het type overeenkomt. Stream binaire antwoorden en haal de bestandsnaam en het type op uit de antwoordheaders.