ДОКУМЕНТАЦИЯ
Аутентификация
Аутентификация осуществляется с помощью API-ключа, который передается в заголовке Authorization в формате Bearer. Получить
API-ключ можно в личном кабинете.
Существует два типа API-ключей:
- Базовый: Поддерживает транскрипцию без диаризации.
- Премиум: Включает транскрипцию с диаризацией (разделением по говорящим).
Включите API-ключ в каждый запрос следующим образом:
Транскрибация
API Scribex предоставляет эндпоинт для транскрипции аудио- или видеофайлов в текст через POST https://api.scribex.ru/transcribe. Для пользователей с премиум-тарифом доступна диаризация (разделение текста по говорящим).
Тело запроса
Запрос должен быть отправлен в формате multipart/form-data со следующим полем:
| Поле | Тип | Описание |
|---|---|---|
audio | string или file | Обязательное. Либо URL-адрес публично доступного аудио-/видеофайла, либо прямое вложение файла. |
Ответ
API возвращает JSON-объект с результатами транскрипции. Для пользователей с премиум-тарифом ответ включает
диаризацию (разделение по говорящим) в поле segments.
Пример ответа:
Примеры запросов
Пример с использованием URL:
Пример с загрузкой файла:
Поддерживаемые форматы
API Scribex поддерживает следующие форматы аудио- и видеофайлов:
- Аудио:
.mp3,.wav,.flac,.ogg,.opus,.m4a - Видео:
.webm,.mp4
Ограничения и лимиты
API ScribeX имеет следующие ограничения на запросы, размер файлов и длительность аудио:
- Лимит запросов: 30 запросов в минуту для всех тарифов (базовый и премиум). При превышении возвращается ошибка 429.
- Максимальный размер файла: 1 ГБ. Максимальный размер загружаемого файла (для прямой загрузки или скачивания по URL). При превышении возвращается ошибка 400.
- Минимальная длительность аудио: 1 секунда. Длительность округляется до 1 секунды для расчета стоимости.
- Максимальная длительность аудио: 10 часов. При превышении возвращается ошибка 400.
Для увеличения лимитов свяжитесь с поддержкой по адресу info@scribex.ru
Возможные ошибки
API ScribeX использует стандартные HTTP коды ответов для указания успеха или неудачи запросов.
| Код ошибки | Заголовок | Описание |
|---|---|---|
| 400 | Bad Request: Invalid form-data | Неверный формат данных формы multipart/form-data. |
| 400 | Bad Request: File size exceeds 100 MB | Размер загруженного файла превышает 100 МБ. |
| 400 | Bad Request: Unsupported file format. | Формат файла не поддерживается. |
| 400 | Bad Request: Audio must be a file or URL | Параметр audio должен быть файлом или URL, начинающимся с http. |
| 400 | Bad Request: Failed to process audio input | Не удалось обработать входной аудиофайл (например, недоступный URL). |
| 400 | Bad Request: Audio duration exceeds 60 minutes | Длительность аудио превышает 60 минут. |
| 402 | Payment Required: Insufficient funds | Недостаточно средств на балансе для оплаты транскрипции. |
| 403 | Forbidden: Missing API key | API-ключ не указан в заголовке Authorization. |
| 403 | Forbidden: Invalid API key | Указанный API-ключ недействителен или не зарегистрирован. |
| 429 | Too Many Requests | Превышен лимит запросов (30 в минуту). |
Поддерживаемые языки
API Scribex поддерживает транскрипцию для широкого спектра языков. Язык определяется автоматически нашей системой.
| Код языка | Название языка |
|---|---|
| af | Африкаанс |
| am | Амхарский |
| ar | Арабский |
| as | Ассамский |
| az | Азербайджанский |
| ba | Башкирский |
| be | Белорусский |
| bg | Болгарский |
| bn | Бенгальский |
| bo | Тибетский |
| br | Бретонский |
| bs | Боснийский |
| ca | Каталанский |
| cs | Чешский |
| cy | Валлийский |
| da | Датский |
| de | Немецкий |
| el | Греческий |
| en | Английский |
| es | Испанский |
| et | Эстонский |
| eu | Баскский |
| fa | Персидский |
| fi | Финский |
| fo | Фарерский |
| fr | Французский |
| gl | Галисийский |
| gu | Гуджарати |
| ha | Хауса |
| haw | Гавайский |
| he | Иврит |
| hi | Хинди |
| hr | Хорватский |
| ht | Гаитянский креольский |
| hu | Венгерский |
| hy | Армянский |
| id | Индонезийский |
| is | Исландский |
| it | Итальянский |
| ja | Японский |
| jw | Яванский |
| ka | Грузинский |
| kk | Казахский |
| km | Кхмерский |
| kn | Каннада |
| ko | Корейский |
| la | Латинский |
| lb | Люксембургский |
| ln | Лингала |
| lo | Лаосский |
| lt | Литовский |
| lv | Латышский |
| mg | Малагасийский |
| mi | Маори |
| mk | Македонский |
| ml | Малаялам |
| mn | Монгольский |
| mr | Маратхи |
| ms | Малайский |
| mt | Мальтийский |
| my | Бирманский |
| ne | Непальский |
| nl | Нидерландский |
| nn | Нюнорск |
| no | Норвежский |
| oc | Окситанский |
| pa | Панджаби |
| pl | Польский |
| ps | Пушту |
| pt | Португальский |
| ro | Румынский |
| ru | Русский |
| sa | Санскрит |
| sd | Синдхи |
| si | Сингальский |
| sk | Словацкий |
| sl | Словенский |
| sn | Шона |
| so | Сомалийский |
| sq | Албанский |
| sr | Сербский |
| su | Сунданский |
| sv | Шведский |
| sw | Суахили |
| ta | Тамильский |
| te | Талугу |
| tg | Таджикский |
| th | Тайский |
| tk | Туркменский |
| tl | Тагальский |
| tr | Турецкий |
| tt | Татарский |
| uk | Украинский |
| ur | Урду |
| uz | Узбекский |
| vi | Вьетнамский |
| yi | Идиш |
| yo | Йоруба |
| yue | Кантонский |
| zh | Китайский |