Перейти до вмісту

Інструменти для документів і файлів

OmniDoc пропонує синхронні інструменти для роботи з файлами та можливість відстежувати асинхронні операції над документами. Спочатку викликайте кінцеві точки функціональних можливостей; не закодовуйте жорстко підтримувані формати чи обмеження в клієнті.

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

Ці записи повертають поточні відкриті операції, їхні формати вводу, тарифікацію та технічні обмеження. Функціональні можливості, перелічені у розділі unavailable, неможливо створити.

Асинхронні операції з документами

Section titled “Асинхронні операції з документами”
POST /api/v1/document-operations
Idempotency-Key: unique-request-id
{
"document_id": "4q8mx2q9z1k7p6ra",
"kind": "visual_extract"
}

Цей ендпоінт вимагає Idempotency-Key. kind наразі містить:

  • extract: структурований витяг, безкоштовно.
  • pdf_to_html: PDF до онлайн HTML, безкоштовно.
  • visual_extract: візуальне структуроване видобуток, оплата за кожну сторінку (1 кредит за сторінку). Перед початком обробки кількість сторінок, які можна обробити, встановлюється згідно з балансом (максимум 20 сторінок); якщо баланс покриває менше ніж 1 сторінку, повертається 402. Після завершення обробки оплачуються фактично оброблені сторінки, і баланс може стати від’ємним.

Запит і скасування:

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

Після завершення output_document_id відповіді може бути переміщено до бібліотеки файлів або іншого завдання, а credit_operation_id містить запис про розрахунок.

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

Приклад об’єднання:

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

Приклад розриву:

{"document_id":"4q8mx2q9z1k7p6ra","ranges":["1-3","5","8-10"]}

Інструменти для роботи з зображеннями

Section titled “Інструменти для роботи з зображеннями”
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

Інструменти приймають лише документи, якими володіє поточний обліковий запис і тип яких збігається. Струмінуйте бінарні відповіді та отримуйте ім’я файлу й тип із заголовків відповіді.