Moknah Документы
Начать бесплатно
Справочник по API

Список голосов

Получить доступные голоса для TTS

ПУБЛИКАЦИЯ /api/v1/voices/

Возвращает список всех голосов, которые аутентифицированный пользователь может использовать с API Text-to-Speech.

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

Укажите свой API-ключ в заголовке Authorization в формате Bearer YOUR_API_KEY.

Тело запроса

Параметр Обязательно Тип Описание
language по выбору строка Язык названий голосов и значений бейджей, например ar, fr или zh-hans (можно также передать как ?language= в URL). Голос без текста на этом языке показывается на английском; так же и при отсутствующем или неподдерживаемом коде. Заголовок ответа Content-Language показывает использованный язык.
engine по выбору строка Ваш API-ключ показывает только голоса своего типа (стандартного или расширенного, выбранного при создании ключа). Если вы передаёте engine, он должен совпадать с типом ключа.

Ответ

Поле Тип Описание
voice_id целое число Уникальный идентификатор голоса
voice_name строка Отображаемое имя для голосовой связи
voice_sample_url строка URL-адрес аудиофайла с образцом голоса
voice_fees плавать Плата за использование этого голоса (0 означает бесплатно)
voice_badges объект Дополнительные метаданные для голоса, например: язык, пол, возраст, сценарий использования.
voice_engine строка стандартный или расширенный. Голоса стандартного движка используют режим; голоса расширенного движка используют контекст, обстановку, стиль и темп. См. Двигатели и режимы.

Пример

curl "https://moknah.io/api/v1/voices/" \
  -H "Authorization: Bearer YOUR_API_KEY"
import requests

response = requests.post(
    "https://moknah.io/api/v1/voices/",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)

voices = response.json()
for voice in voices:
    print(voice["voice_name"], voice["voice_sample_url"])
const response = await fetch(
    'https://moknah.io/api/v1/voices/',
    {
        headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
    }
);

const voices = await response.json();
console.log(voices);

Пример ответа

[
    {
        "voice_id": 1328,
        "voice_name": "Adnan",
        "voice_sample_url": "https://storage.moknah.io/media/voice_samples/Adnan.mp3",
        "voice_fees": 0.0,
        "voice_badges": {
            "language": "Arabic",
            "gender": "Male",
            "age": "Young Adult",
            "use_case": "Documentary, Audiobook, Article",
        },
        "voice_engine": "standard"
    }
]
Поддержка API

По вопросам или проблемам, связанным с API, обращайтесь к нам по адресу api@moknah.io.