Skip to main content
GET
cURL

Continue building

Convert text to speech

Generate speech with this voice.

Get voice settings

Read saved generation settings.

Edit a voice

Edit a voice you can manage.

Authorizations

xi-api-key
string
header
required

Breeze Developer API key.

Path Parameters

voice_id
string
required

Voice identifier returned by GET /v1/voices. See List voices.

Response

Voice metadata.

voice_id
string
required
name
string
required

Display name for the authenticated account. A saved public voice uses the personal alias set in Voice Library, when present.

origin
string
required
voice_type
string
required
settings
VoiceSettingsResponse · object
required
language_code
enum<string>
required
Available options:
af,
ar,
bg,
bn,
bs,
ca,
cs,
da,
de,
el,
en,
es,
et,
eu,
fa,
fi,
fr,
gl,
he,
hi,
hu,
id,
is,
it,
ja,
kn,
ko,
lt,
mr,
ms,
ne,
nl,
no,
pl,
pt,
ro,
ru,
sk,
sl,
sq,
sv,
sw,
ta,
te,
th,
tl,
tr,
uk,
ur,
vi,
zh
gender
enum<string> | null
required
Available options:
male,
female,
neutral
age
enum<string> | null
required
Available options:
child,
young,
middle_aged,
old
tone
enum<string>[]
required
Maximum array length: 3
Available options:
warm,
calm,
bright,
gentle,
energetic,
authoritative,
sincere,
weary,
precise,
refined,
urgent,
friendly,
articulate,
steady,
playful,
compassionate,
reflective,
measured,
rhythmic,
passionate
accent
enum<string> | null
required
Available options:
american,
british,
scottish,
irish,
australian,
canadian,
us_southern,
us_new_york,
indian,
south_african,
russian,
japanese,
korean,
chinese,
mandarin_northeastern,
mandarin_shaanxi,
mandarin_shanghai,
mandarin_sichuan,
mandarin_henan,
mandarin_beijing,
mandarin_taiwan,
cantonese,
mandarin_guangdong,
mandarin_yunnan
tags
string[]
Maximum array length: 20
Maximum string length: 128
is_favorited
boolean
default:false
preview_url
string | null
description
string | null
publication_status
string | null

Owner-only publication review state: queued, processing, published, needs_review, failed, or superseded. Null when unavailable.

publication_job_id
string | null
publication_error_code
string | null
created_at_unix
integer | null