Общая информация

Обзор

ViClient API представляет собой REST API для обработки видео и аудио контента с функциями расшифровки, анализа, создания временных меток, суммаризации, создания квизов и поиска по содержимому.

Базовый URL: https://your-domain.com

Аутентификация

Все запросы требуют аутентификации с помощью API ключа, который передается в заголовке:

x-api-key: your-api-key-here

Доступные действия

API поддерживает следующие типы обработки контента:

• transcript - Расшифровка речи в текст

• timecodes - Создание временных меток

• summary - Создание краткого изложения

• quiz - Генерация вопросов и тестов

• frames - Извлечение кадров из видео

• search - Поиск по содержимому

Статусы задач

• queued - Задача в очереди на выполнение

• in_progress - Задача выполняется

• done - Задача завершена успешно

• failed - Задача завершена с ошибкой

Поддерживаемые форматы файлов

• Видео: mp4, avi, mkv, webm, mov

• Аудио: mp3

Коды ошибок

• 400 Bad Request - Некорректные параметры запроса

• 401 Unauthorized - Отсутствует или недействительный API ключ

• 404 Not Found - Задача или ресурс не найден

• 422 Unprocessable Entity - Ошибки валидации данных

• 500 Internal Server Error - Внутренняя ошибка сервера

Пример ошибки

{
    "detail": "File link is required"
}

Ограничения

• Максимальное время обработки: 30 минут на продукт

• Поддерживаемые форматы файлов: mp4, avi, mkv, webm, mov, mp3

• Максимальное количество результатов поиска: не ограничено (рекомендуется до 50)