Skip to content
Lumean API
GET/voices/tags

Voice Tags

The reference of active voice tags, named in the request language.

voices.read

Needed for the tag_ids[] filter of GET /voices/public: take the ids of the tags you want from here. The language of the names follows the X-Locale header.

Required key permission: voices.read.

On this page(2)

Possible responses

200

Success. The payload is in data.

Body example
{
  "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
    }
  ]
}
Response fields
successrequired

Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.

boolean
messagerequired

A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.

string
datarequired

The complete tag directory — the same set that appears in each voice’s tags.

array<VoiceTag>VoiceTag
array item
idrequired

Internal identifier of the tag.

integer
coderequired

Tag code — the stable value to filter by, unlike the translatable name.

string
namerequired

Tag name in the account language.

string
descriptionrequired

Explanation of the tag in the account language, when the author provided one.

nullable
string
colorrequired

Tag colour in HEX — a styling hint.

string
sort_orderrequired

Sort weight within the tag list: lower comes first.

integer
401

The key is missing, unknown, disabled or expired.

Analyse this response
Body example
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Response fields
successrequired

Always false in error responses.

boolean
messagerequired

Error text in the key's language (set through the X-Locale header).

string
datarequired

Always null when the request is rejected before processing.

nullable
null
403

The key lacks the required permission, or the object belongs to another user.

Analyse this response
Body example
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Response fields
successrequired

Always false in error responses.

boolean
messagerequired

Error text in the key's language (set through the X-Locale header).

string

Nearby

The same in words

Objects

Neighbouring operations

Feed this page to an AI

Open .mdllm.md

spec 0.0.1