К содержанию
Lumean API

GET/voices/heygen/filters

Справочник значений для фильтров каталога HeyGen: движки рендера, языки, акценты и лейблы — каждое со счётчиком публично видимых голосов.

voices.read

Вызовите эту ручку перед GET /voices/heygen, чтобы знать, что можно подставить в language, accent и voice_engine: написание там провайдерское (English, en-US), угадывать его не нужно.

Требуемое право ключа: voices.read.

На этой странице(2)

Возможные ответы

200

Доступные фильтры каталога голосов HeyGen

Пример тела
{
  "success": true,
  "message": "HeyGen voice filters retrieved successfully.",
  "data": {
    "voice_engines": [
      {
        "value": "elevenLabs",
        "count": 1820
      },
      {
        "value": "azure",
        "count": 410
      },
      {
        "value": "cartesia",
        "count": 98
      }
    ],
    "genders": [
      {
        "value": "female",
        "count": 1240
      },
      {
        "value": "male",
        "count": 1080
      },
      {
        "value": "unknown",
        "count": 10
      }
    ],
    "languages": [
      {
        "value": "English",
        "count": 640
      },
      {
        "value": "Spanish",
        "count": 210
      },
      {
        "value": "French",
        "count": 150
      }
    ],
    "accents": [
      {
        "value": "en-US",
        "count": 420
      },
      {
        "value": "en-GB",
        "count": 180
      },
      {
        "value": "es-ES",
        "count": 110
      }
    ],
    "labels": [
      {
        "value": "Conversational",
        "count": 530
      },
      {
        "value": "Warm",
        "count": 340
      },
      {
        "value": "Energetic",
        "count": 275
      }
    ]
  }
}
Поля ответа
successобязательное

Признак успеха. Решение принимайте по HTTP-коду: у любого ответа 2xx здесь true, а ошибка приходит телом другой формы, где этого поля может не быть вовсе.

boolean
messageобязательное

Пояснение для человека, на языке аккаунта. Показать пользователю можно; разбирать программно — нет: формулировки меняются без предупреждения и кодом ошибки не являются.

string
dataобязательное

Полезная нагрузка ответа.

object
voice_enginesобязательное

Допустимые значения фильтра voice_engine со счётчиком голосов.

array<object>
элемент массива
valueобязательное

Значение, которое подставляется в фильтр.

string
countобязательное

Сколько голосов останется при этом значении.

integer
gendersобязательное

Допустимые значения фильтра gender со счётчиком.

array<object>
элемент массива
valueобязательное

Значение, которое подставляется в фильтр.

string
countобязательное

Сколько голосов останется при этом значении.

integer
languagesобязательное

Допустимые значения фильтра language — в написании провайдера, со счётчиком.

array<object>
элемент массива
valueобязательное

Значение, которое подставляется в фильтр.

string
countобязательное

Сколько голосов останется при этом значении.

integer
accentsобязательное

Допустимые значения фильтра accent со счётчиком.

array<object>
элемент массива
valueобязательное

Значение, которое подставляется в фильтр.

string
countобязательное

Сколько голосов останется при этом значении.

integer
labelsобязательное

Метки голосов со счётчиком. Отдельного фильтра по ним нет — ищите через search.

array<object>
элемент массива
valueобязательное

Значение метки.

string
countобязательное

Сколько голосов несёт эту метку.

integer
401

Невалидный или отсутствующий X-API-KEY

Разобрать этот ответ
Пример тела
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Поля ответа
successобязательное

Всегда false в ответах об ошибке.

boolean
messageобязательное

Текст ошибки на языке ключа (задаётся заголовком X-Locale).

string
dataобязательное

Всегда null, когда запрос отклонён до обработки.

может быть null
null
403

У ключа нет права voices.read

Разобрать этот ответ
Пример тела
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Поля ответа
successобязательное

Всегда false в ответах об ошибке.

boolean
messageобязательное

Текст ошибки на языке ключа (задаётся заголовком X-Locale).

string

Рядом

Об этом словами

Соседние операции

Скормить страницу ИИ

Открыть .mdllm.md

спека 0.0.1