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