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 'Authorization: Bearer <token>'
{
  "voice_id": "vl-xiaoxiao",
  "name": "Xiaoxiao",
  "language": "zh-CN",
  "locale": "zh-CN",
  "display_name": "Xiaoxiao",
  "gender": "female",
  "age": "young",
  "description": "A cheerful and energetic voice",
  "styles": [
    "cheerful",
    "sad",
    "angry"
  ],
  "sample_url": "https://api.example.com/api/v1/samples/vl-xiaoxiao",
  "voice_config_schema": {}
}

Authorizations

​
Authorization
string
header
required

Authenticate using Bearer Token, where the token is an API Key

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"

​
language
string
required

Language code (ISO 639-1)

Example:

"zh-CN"

​
locale
string
required

Locale code (ISO 3166-1)

Example:

"zh-CN"

​
display_name
string

Display name (localized)

Example:

"Xiaoxiao"

​
gender
enum<string>

Gender

Available options:
male,
female,
neutral
Example:

"female"

​
age
enum<string>

Age group

Available options:
child,
young,
adult,
senior
Example:

"young"

​
description
string

Description

Example:

"A cheerful and energetic voice"

​
styles
string[]

Supported styles list

Example:
["cheerful", "sad", "angry"]
​
sample_url
string

Sample audio URL

Example:

"https://api.example.com/api/v1/samples/vl-xiaoxiao"

​
voice_config_schema
object

Schema for configuration items supported by this voice