Перейти к содержимому

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

OmniDoc предоставляет синхронные инструменты для работы с файлами и отслеживаемые асинхронные операции над документами. Сначала вызывайте конечные точки API; не закодируйте вручную поддерживаемые форматы или ограничения в клиентском приложении.

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

Эти элементы возвращают текущие открытые операции, их форматы ввода, ограничения по выставлению счетов и технические лимиты. Возможности, перечисленные под unavailable, создать нельзя.

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"]}
POST /api/v1/file-tools/image/convert
POST /api/v1/file-tools/image/compress
{
"document_id": "4q8mx2q9z1k7p6ra",
"target_format": "webp",
"quality": 85
}

Инструменты принимают только документы, принадлежащие текущей учётной записи и соответствующие указанному типу. Потоковая передача двоичных ответов; имя файла и его тип извлекаются из заголовков ответа.