Skip to main content
GET
/
v1
/
voices
/
{voice_id}
Get Voice Details
curl --request GET \
  --url https://api.voxnexus.ai/v1/voices/{voice_id} \
  --header 'X-Api-Key: <api-key>'
{
  "voice_id": "vl-xiaoxiao",
  "name": "Xiaoxiao",
  "gender": "female",
  "primary_locale": "zh-CN",
  "display_name": "Xiaoxiao",
  "category": "premade",
  "description": "A warm and friendly female voice, suitable for general scenarios",
  "is_multilingual": true,
  "supported_locales": [
    {
      "locale": "zh-CN",
      "language": "zh",
      "locale_name": "Chinese (Simplified, China)",
      "accent": "mandarin",
      "preview_url": "https://api.voxnexus.ai/samples/vl-xiaoxiao/zh-CN.mp3",
      "is_primary": true
    }
  ],
  "labels": {
    "personalities": [
      "warm",
      "friendly"
    ],
    "scenarios": [
      "assistant",
      "news"
    ]
  },
  "preview_url": "https://api.voxnexus.ai/samples/vl-xiaoxiao.mp3",
  "config_schema": {}
}

Authorizations

​
X-Api-Key
string
header
required

Authenticate using X-Api-Key header

Path Parameters

​
voice_id
string
required

Voice unique identifier

Example:

"vl-xiaoxiao"

Response

Successfully returns voice details

​
voice_id
string
required

Voice unique identifier

Example:

"vl-xiaoxiao"

​
name
string
required

Voice name

Example:

"Xiaoxiao"

​
gender
enum<string>
required

Gender

Available options:
male,
female,
neutral
Example:

"female"

​
primary_locale
string
required

Primary locale code

Example:

"zh-CN"

​
display_name
string

Display name (localized)

Example:

"Xiaoxiao"

​
category
enum<string>

Voice category

Available options:
premade,
cloned,
generated
Example:

"premade"

​
description
string

Voice description

Example:

"A warm and friendly female voice, suitable for general scenarios"

​
is_multilingual
boolean

Whether the voice supports multiple languages

Example:

true

​
supported_locales
object[]

List of supported locales with details

​
labels
object

Display labels (personalities, scenarios, etc.)

Example:
{
  "personalities": ["warm", "friendly"],
  "scenarios": ["assistant", "news"]
}
​
preview_url
string

Default sample audio URL

Example:

"https://api.voxnexus.ai/samples/vl-xiaoxiao.mp3"

​
config_schema
object

Specific configuration schema