> For the complete documentation index, see [llms.txt](https://visaver.gitbook.io/visaver-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://visaver.gitbook.io/visaver-api/dokumentaciya/obshaya-informaciya.md).

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

## Обзор

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

**Базовый URL:** `https://api.visaver.com`

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

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

```http
vendor-key: your-vendor-key-here
```

Ключ выдаётся администратором сервиса. При отсутствующем или неверном ключе API возвращает `401 Unauthorized`.

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

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

* `transcript` — расшифровка речи в текст
* `timecodes` — создание временных меток
* `summary` — создание краткого изложения
* `quiz` — генерация вопросов и тестов
* `frames` — извлечение кадров из видео
* `search` — поиск по содержимому
* `semantic_search` — семантический (векторный) поиск по содержимому
* `multimodal_search` — мультимодальный поиск по кадрам видео (текстом или картинкой)

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

* `queued` — задача в очереди на выполнение
* `in_progress` — задача выполняется
* `done` — задача завершена успешно
* `failed` — задача завершена с ошибкой

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

* Видео: `mp4`, `avi`, `mkv`, `webm`, `mov`
* Аудио: `mp3`
* Потоковое видео: `m3u8`

## Коды ошибок

* `400 Bad Request` — некорректные параметры запроса
* `401 Unauthorized` — отсутствует или недействительный API ключ
* `404 Not Found` — задача или ресурс не найден
* `422 Unprocessable Entity` — ошибки валидации данных
* `500 Internal Server Error` — внутренняя ошибка сервера

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

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

## Ограничения

* Максимальное время обработки: 30 минут на продукт
* Поддерживаемые форматы файлов: `mp4`, `avi`, `mkv`, `webm`, `mov`, `mp3`, `m3u8`
* `speakers_count`: от 0 (автоопределение) до 10
* `n_results` в поисковых запросах: от 1 до 50 (по умолчанию 5)