Инструменты для документов и файлов
OmniDoc предоставляет синхронные инструменты для работы с файлами и отслеживаемые асинхронные операции над документами. Сначала вызывайте конечные точки API; не закодируйте вручную поддерживаемые форматы или ограничения в клиентском приложении.
Обнаружение возможностей
Заголовок раздела «Обнаружение возможностей»GET /api/v1/document-operations/capabilitiesGET /api/v1/artifacts/convert/capabilitiesЭти элементы возвращают текущие открытые операции, их форматы ввода, ограничения по выставлению счетов и технические лимиты. Возможности, перечисленные под unavailable, создать нельзя.
Асинхронные операции с документами
Заголовок раздела «Асинхронные операции с документами»POST /api/v1/document-operationsIdempotency-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=25POST /api/v1/document-operations/{operation_id}/cancelПо завершении ответ output_document_id может быть помещён в библиотеку файлов или передан другому заданию, а credit_operation_id содержит запись о расчёте.
Инструменты PDF
Заголовок раздела «Инструменты PDF»POST /api/v1/file-tools/pdf/mergePOST /api/v1/file-tools/pdf/splitPOST /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/convertPOST /api/v1/file-tools/image/compress{ "document_id": "4q8mx2q9z1k7p6ra", "target_format": "webp", "quality": 85}Инструменты принимают только документы, принадлежащие текущей учётной записи и соответствующие указанному типу. Потоковая передача двоичных ответов; имя файла и его тип извлекаются из заголовков ответа.