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

GET/voices/tags

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

voices.read

Нужен для фильтра tag_ids[] в GET /voices/public: возьмите id подходящих тегов отсюда. Язык названий выбирается заголовком X-Locale.

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

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

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

200

Доступные теги

Пример тела
{
  "success": true,
  "message": "Success",
  "data": [
    {
      "id": 1,
      "code": "male",
      "name": "Male",
      "description": null,
      "color": null,
      "sort_order": 10
    },
    {
      "id": 2,
      "code": "female",
      "name": "Female",
      "description": null,
      "color": null,
      "sort_order": 20
    },
    {
      "id": 3,
      "code": "neutral",
      "name": "Neutral",
      "description": null,
      "color": null,
      "sort_order": 30
    },
    {
      "id": 4,
      "code": "calm",
      "name": "Calm",
      "description": null,
      "color": null,
      "sort_order": 40
    },
    {
      "id": 5,
      "code": "energetic",
      "name": "Energetic",
      "description": null,
      "color": null,
      "sort_order": 50
    },
    {
      "id": 6,
      "code": "young",
      "name": "Young",
      "description": null,
      "color": null,
      "sort_order": 60
    },
    {
      "id": 7,
      "code": "mature",
      "name": "Mature",
      "description": null,
      "color": null,
      "sort_order": 70
    },
    {
      "id": 8,
      "code": "narration",
      "name": "Narration",
      "description": null,
      "color": null,
      "sort_order": 80
    },
    {
      "id": 9,
      "code": "gaming",
      "name": "Gaming",
      "description": null,
      "color": null,
      "sort_order": 90
    },
    {
      "id": 10,
      "code": "character",
      "name": "Character",
      "description": null,
      "color": null,
      "sort_order": 100
    },
    {
      "id": 11,
      "code": "warm",
      "name": "Warm",
      "description": null,
      "color": null,
      "sort_order": 110
    },
    {
      "id": 12,
      "code": "cold",
      "name": "Cold",
      "description": null,
      "color": null,
      "sort_order": 120
    }
  ]
}
Поля ответа
successобязательное

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

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

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

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

Справочник меток целиком — тот же набор, что приходит в tags каждого голоса.

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

Внутренний идентификатор метки.

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

Код метки — устойчивое значение для фильтрации, в отличие от переводимого name.

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

Название метки на языке аккаунта.

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

Пояснение к метке на языке аккаунта, если автор его задал.

может быть null
string
colorобязательное

Цвет метки в HEX — подсказка для оформления.

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

Вес сортировки в списке меток: меньше — выше.

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