Przejdź do głównej zawartości

Narzędzia do dokumentów i plików

OmniDoc oferuje narzędzia do pracy z plikami w trybie synchronicznym oraz śledzone operacje dokumentów w trybie asynchronicznym. Najpierw wywołuj punkty końcowe funkcjonalności; nie koduj wprost obsługiwanych formatów ani limitów w kliencie.

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

Zwracają one aktualnie otwarte operacje, ich formaty wejściowe, limity rozliczeniowe i techniczne. Możliwości wymienione pod kluczem unavailable nie mogą zostać utworzone.

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

Ten punkt końcowy wymaga Idempotency-Key. Obecnie kind obejmuje:

  • extract: strukturalne wyodrębnianie, bezpłatne.
  • pdf_to_html: PDF do online HTML, bezpłatnie.
  • visual_extract: wizualne wyodrębnianie struktury, rozliczane po stronach (1 kredyt za stronę). Przed rozpoczęciem liczba stron, które mogą zostać przetworzone, jest ustalana na podstawie salda (maksymalnie 20 stron); jeśli saldo pokrywa mniej niż 1 stronę, zwracany jest kod 402. Po zakończeniu rozliczane są faktycznie przetworzone strony, a saldo może stać się ujemne.

Zapytanie i anulowanie:

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

Po zakończeniu, output_document_id odpowiedzi może zostać przeniesiony do biblioteki plików lub innego zadania, a credit_operation_id zawiera rekord rozliczenia.

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

Przykład scalania:

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

Przykład podziału:

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

Narzędzia akceptują wyłącznie dokumenty, które są własnością bieżącego konta i których typ jest zgodny. Przekazuj odpowiedzi binarne w strumieniowym trybie, a nazwę pliku oraz jego typ pobieraj z nagłówków odpowiedzi.