Получение API-ключа
Подготовка
- Войдите в MindVoice под учётной записью владельца Workspace или администратора организации с доступом к нему. Управление ключами требует пользовательской сессии; API-ключом создать другой ключ нельзя.
- Выберите Workspace, в котором будут храниться записи. Ключ действует только в этом пространстве. Для каждого другого Workspace нужен отдельный ключ.
- Откройте Настройки → Workspace → API-ключи (
/settings/workspace/api-keys/). Нужен действующий доступ к Workspace.
Создание в интерфейсе
Нажмите Создать API Key, задайте понятное имя интеграции, права и срок действия: 1, 7, 30, 90, 180 или 360 дней либо «Никогда». Для полного цикла загрузки и получения результатов выдайте recordings:write, recordings:read, transcripts:write, transcripts:read, analysis:write, analysis:read. Если сценарии запускаются автоматически, права записи для транскрибации и анализа ключу не нужны, пока интеграция не выполняет ручной запуск.
Скопируйте секрет ws-sk-… сразу после создания: полностью он показывается один раз. В списке остаются только Tracking ID ws-key-<UUID> и маска секрета; Tracking ID не подходит для авторизации. Храните секрет в менеджере секретов серверного приложения. Не помещайте его в браузер, мобильное приложение, репозиторий и логи.
Отправляйте в каждом запросе:
Authorization: Bearer <api_key>
Срок ключа можно продлить через интерфейс; отозванный ключ восстановить нельзя. Для ротации создайте новый ключ, обновите его в интеграции и отзовите старый. Истёкший и отозванный секреты не принимаются.
Права
| Scope | Возможности |
|---|---|
recordings:write | Загрузка файлов, импорт по ссылке, изменение и удаление записей |
recordings:read | Список, карточка и скачивание записей |
transcripts:write | Ручной запуск, повтор, отмена и активация сценария транскрибации |
transcripts:read | Сценарии, запуски и тексты транскрибаций |
analysis:write | Ручной запуск, повтор, отмена и активация сценария анализа |
analysis:read | Сценарии, запуски и результаты анализа |
Отчёты и экспорты доступны только через UI с пользовательской сессией. Ключ не даёт права создавать или редактировать сценарии, управлять ключами, финансами и моделями. Недостаточный scope или чужой Workspace приводит к 403.
Проверка доступа
Используйте публичный API https://api.mindvoice.pro и сохранённый секрет:
export MINDVOICE_API_KEY='<секрет-ws-sk>'
curl --fail-with-body 'https://api.mindvoice.pro/api/v1/workspaces' \
-H "Authorization: Bearer $MINDVOICE_API_KEY" \
-H 'Accept: application/json'
Ответ items содержит доступное ключу пространство. Возьмите его id для следующих запросов. Следующий шаг: первый файл.