Обзор API
Base URL
https://omnidoc.top/api/v1Отправляйте запросы Content-Type: application/json вместе с запросами JSON. Ключ API указывается в заголовке X-API-Key или в качестве учётных данных Bearer.
| Сервис | Основные пути | Назначение |
|---|---|---|
| Загрузка файла | /upload/* | Загрузите и подтвердите документы |
| Библиотека файлов | /storage/files/*, /documents/* | Список, чтение и загрузка |
| Перевод | /jobs/*, /artifacts/* | Создавайте задания, проверяйте статус и результаты |
| Инструменты для работы с документами | /document-operations/*, /file-tools/* | Конвертировать, объединять, разделять, сжимать и многое другое |
| Мгновенный перевод | /ai/* | Краткий текст и перевод сегментов пакетами |
| Аудио и видео | /media-jobs/*, /media-voices/* | Работы и голоса |
| Словари | /glossaries/* | Термины, импорт и экспорт |
| Использование и благодарности | /usage/*, /billing/credits/* | Записи об использовании, балансе и расчетах |
| Уведомления | /sse/*, /webhooks/* | Текущий прогресс и обратные вызовы |
Какие службы вы можете вызывать и какова их стоимость: службы и разрешения .
Условные обозначения
Заголовок раздела «Условные обозначения»- Идентификаторы ресурсов представляют собой непрозрачные строки.
- Отправляйте
Idempotency-Keyс запросами на создание; для документирования операций, заданий по работе с мультимедиа и создания голосовых записей требуется один такой объект. - Параметры разбиения на страницы описаны на странице каждого эндпоинта.
- Обработка
429как описано в ошибки и повторные попытки . - Имена загруженных файлов предназначены только для отображения; перед сохранением используйте базовое имя файла и учитывайте ограничения вашей файловой системы.
Отслеживание запросов
Заголовок раздела «Отслеживание запросов»Сохраняйте X-Request-Id каждого ответа. При обращении в службу поддержки укажите это значение, время запроса и путь; никогда не отправляйте полный API‑ключ или содержимое файлов.