Skip to main content
GET
Get Voice Details

Authorizations

X-Api-Key
string
header
required

Authenticate using X-Api-Key header

Path Parameters

voice_id
string
required

Voice unique identifier

Example:

"vn-xiaoxiao"

Query Parameters

model_id
string

Restrict supported_locales to routes available for this model and voice. The primary_locale is omitted if no default is available among multiple remaining locales.

Example:

"vn-tts-basic"

Response

Successfully returns voice details

voice_id
string
required

Voice unique identifier

Example:

"vn-xiaoxiao"

name
string
required

Voice name

Example:

"Xiaoxiao"

gender
enum<string>
required

Gender

Available options:
male,
female,
neutral
Example:

"female"

supported_locales
object[]
required

Actual supported locales. When model_id is supplied, contains only locales available for that model and voice.

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"

primary_locale
string

Available default BCP 47 locale. Belongs to supported_locales; omitted when multiple locales have no declared available default.

Example:

"zh-CN"

is_multilingual
boolean

Whether the voice supports multiple distinct base languages; en-US and en-GB alone do not make it multilingual.

Example:

true

labels
object

Display labels (personalities, scenarios, etc.)

Example:
preview_url
string

Default sample audio URL

Example:

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

config_schema
object

Supported voice_config keys — a flat map from key to its definition (type/description/enum). Omitted when the voice has no configurable keys

Example:
models
string[]

List of supported model IDs for this voice

Example: