Skip to main content
POST
/
api
/
v1
/
language_groups
/
voices
/
sample
Create Voice Sample
curl --request POST \
  --url https://api.syllable.cloud/api/v1/language_groups/voices/sample \
  --header 'Content-Type: application/json' \
  --header 'Syllable-API-Key: <api-key>' \
  --data '
{
  "language_code": "yue-HK",
  "voice_provider": "OpenAI",
  "voice_display_name": "Achernar (English)",
  "voice_speed": 1,
  "voice_pitch": 0,
  "text": "",
  "apply_pronunciation_overrides": false
}
'
"<string>"

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json

Request model to generate a sample audio file for a given voice and language.

​
language_code
enum<string>
required

BCP 47 code of the language

Available options:
yue-HK,
en-US,
ko-KR,
zh-CN,
fa-IR,
es-US,
th-TH,
vi-VN,
bs-BA,
sw-KE,
ru-RU,
hi-IN,
gu-IN
​
voice_provider
enum<string>
required

TTS provider of the voice to use for the language

Available options:
OpenAI,
ElevenLabs,
Google
​
voice_display_name
enum<string>
required

Display name of the voice to use for the language

Available options:
Achernar (English),
Achernar (Gujarati),
Achernar (Hindi),
Achernar (Korean),
Achernar (Mandarin),
Achernar (Spanish),
Achernar (Thai),
Achernar (Vietnamese),
Alice,
Alloy,
Aoede (English),
Aoede (Gujarati),
Aoede (Hindi),
Aoede (Korean),
Aoede (Mandarin),
Aoede (Russian),
Aoede (Spanish),
Aoede (Thai),
Aoede (Vietnamese),
Ash,
Bill,
Brian,
Callirrhoe (English),
Callirrhoe (Gujarati),
Callirrhoe (Hindi),
Callirrhoe (Korean),
Callirrhoe (Mandarin),
Callirrhoe (Spanish),
Callirrhoe (Thai),
Callirrhoe (Vietnamese),
Callum,
Charlie,
Charlotte,
Charon (English),
Charon (Gujarati),
Charon (Hindi),
Charon (Korean),
Charon (Mandarin),
Charon (Russian),
Charon (Spanish),
Charon (Thai),
Charon (Vietnamese),
Chris,
cmn-TW-Wavenet-A,
Coral,
Daniel,
Echo,
en-US-Neural2-D,
en-US-Neural2-F,
en-US-Neural2-J,
en-US-Studio-O,
Eric,
es-US-Neural2-A,
es-US-Neural2-B,
Fable,
Fenrir (English),
Fenrir (Gujarati),
Fenrir (Hindi),
Fenrir (Korean),
Fenrir (Mandarin),
Fenrir (Russian),
Fenrir (Spanish),
Fenrir (Thai),
Fenrir (Vietnamese),
George,
Jessica,
ko-KR-Neural2-A,
Kore (English),
Kore (Gujarati),
Kore (Hindi),
Kore (Korean),
Kore (Mandarin),
Kore (Russian),
Kore (Spanish),
Kore (Thai),
Kore (Vietnamese),
Laura,
Leda (English),
Leda (Gujarati),
Leda (Hindi),
Leda (Korean),
Leda (Mandarin),
Leda (Russian),
Leda (Spanish),
Leda (Thai),
Leda (Vietnamese),
Liam,
Lily,
Matilda,
Nova,
Onyx,
Orus (English),
Orus (Gujarati),
Orus (Hindi),
Orus (Korean),
Orus (Mandarin),
Orus (Russian),
Orus (Spanish),
Orus (Thai),
Orus (Vietnamese),
Puck (English),
Puck (Gujarati),
Puck (Hindi),
Puck (Korean),
Puck (Mandarin),
Puck (Russian),
Puck (Spanish),
Puck (Thai),
Puck (Vietnamese),
River,
Roger,
Sarah,
Sage,
Shimmer,
Umbriel (English),
Umbriel (Gujarati),
Umbriel (Hindi),
Umbriel (Korean),
Umbriel (Mandarin),
Umbriel (Spanish),
Umbriel (Thai),
Umbriel (Vietnamese),
Vindemiatrix (English),
Vindemiatrix (Gujarati),
Vindemiatrix (Hindi),
Vindemiatrix (Korean),
Vindemiatrix (Mandarin),
Vindemiatrix (Spanish),
Vindemiatrix (Thai),
Vindemiatrix (Vietnamese),
vi-VN-Neural2-A,
Will,
yue-HK-Standard-C,
Zephyr (English),
Zephyr (Gujarati),
Zephyr (Hindi),
Zephyr (Korean),
Zephyr (Mandarin),
Zephyr (Russian),
Zephyr (Spanish),
Zephyr (Thai),
Zephyr (Vietnamese)
​
voice_speed
number | null

Speed of the voice in the range of 0.25 to 4.0 (OpenAI and Google) or 0.7 to 1.2 (ElevenLabs). Standard speed is 1.0.

Example:

1

​
voice_pitch
number | null

Pitch of the voice in the range of -20.0 to 20.0. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. 0 means use the original pitch. Only supported for Google configs.

Example:

0

​
text
string
default:""

Text to generate for this voice.

​
apply_pronunciation_overrides
boolean
default:false

Apply TTS pronunciation fixes.

Response

Successful Response

The response is of type file.