Документация

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

📖 Документация API

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

Основы работы с API, аутентификация, статусы задач, коды ошибок и ограничения:

  • Аутентификация через API ключи

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

  • Доступные типы обработки

  • Статусы и коды ошибок

Управление задачами

Полное руководство по работе с задачами обработки контента:

  • Создание новых задач

  • Получение списка и информации о задачах

  • Получение результатов обработки (транскрипт, временные метки, краткое изложение, квиз, кадры)

  • Получение всех продуктов сразу

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

Семантический поиск по обработанному контенту:

  • Поиск по одной или нескольким задачам

  • Параметры поиска и ранжирование результатов

  • Интеграция с кадрами видео

Webhook уведомления

Автоматические уведомления о завершении обработки:

  • Структура webhook уведомлений

  • Примеры обработчиков (Python, Node.js)

  • Отладка и устранение неполадок

  • Рекомендации по безопасности

Экспорт данных

Экспорт результатов в различные форматы:

  • Поддерживаемые форматы (TXT, DOCX)

  • Примеры использования

  • Программное скачивание файлов

  • Форматирование экспортируемых данных

🚀 Быстрый старт

  1. Получите API ключ - обратитесь к администратору системы

  2. Ознакомьтесь с общей информацией - изучите основы API

  3. Создайте первую задачу - следуйте инструкциям в разделе управления задачами

  4. Настройте webhook - для автоматических уведомлений используйте webhook документацию

🛠 Для администраторов

Развертывание для клиентов

Подробная инструкция по развертыванию сервиса на площадке клиента:

  • Требования к серверу

  • Настройка переменных окружения

  • Процедуры развертывания и обновления

📋 Краткий обзор возможностей

Функция
Описание
Формат экспорта

Transcript

Расшифровка речи в текст с временными метками и определением спикеров

JSON, TXT, DOCX

Timecodes

Создание временных меток с описанием содержимого

JSON, TXT, DOCX

Summary

Автоматическое создание краткого изложения

JSON, TXT, DOCX

Quiz

Генерация вопросов и тестов по содержимому

JSON, TXT, DOCX

Frames

Извлечение ключевых кадров из видео

JSON

Search

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

JSON

🎯 Типичные сценарии использования

Обработка образовательного контента

# 1. Создать задачу для обработки лекции
curl -X POST "https://api.example.com/jobs/" \
  -H "x-api-key: your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "actions": ["transcript", "summary", "quiz", "timecodes", "frames", "search"],
    "file_link": "https://example.com/lecture.mp4",
    "webhook_url": "https://your-site.com/webhook"
  }'

# 2. После завершения - экспорт материалов
curl -X GET "https://api.example.com/jobs/{job_id}/quiz/?format=docx" \
  -H "x-api-key: your-key" \
  -o quiz.docx

Анализ корпоративных встреч

# 1. Обработка записи встречи с автоопределением спикеров
curl -X POST "https://api.example.com/jobs/" \
  -H "x-api-key: your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "actions": ["transcript", "summary", "timecodes", "search"],
    "file_link": "https://example.com/meeting.mp4",
    "speakers_count": 0
  }'

# 2. Поиск по ключевым темам
curl -X POST "https://api.example.com/search/" \
  -H "x-api-key: your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "бюджет проекта",
    "job_id": "{job_id}",
    "n_results": 10
  }'

📞 Поддержка

Если у вас есть вопросы или проблемы:

  1. Проверьте документацию - большинство вопросов освещены в соответствующих разделах

  2. Изучите примеры кода - в каждом разделе есть готовые примеры

  3. Обратитесь в поддержку - укажите job_id и подробное описание проблемы

🔄 Обновления документации

Документация регулярно обновляется. Следите за изменениями в репозитории.

Версия документации: v1.0 Последнее обновление: 2025-09-08

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

Last updated