API Reference
API Reference

Create Voice Sample

Generate voice sample.

POST/api/v1/voice_groups/voices/sample

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

application/json

body VoiceSampleCreateRequest required
7 fields
language_codeenum<string>required

BCP 47 code of the language

Allowed values ["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","ar-XA","fr-FR","ja-JP","ne-NP"]
voice_providerenum<string>required

TTS provider of the voice to use for the language

Allowed values ["OpenAI","ElevenLabs","Google","Cartesia"]
voice_display_nameenum<string>required

Display name of the voice to use for the language

Allowed values ["Achernar (English)","Achernar (Gujarati)","Achernar (Arabic)","Achernar (French)","Achernar (Japanese)","Achernar (Hindi)","Achernar (Korean)","Achernar (Mandarin)","Achernar (Spanish)","Achernar (Thai)","Achernar (Vietnamese)","Alice","Alloy","Aoede (English)","Aoede (Gujarati)","Aoede (Arabic)","Aoede (French)","Aoede (Japanese)","Aoede (Hindi)","Aoede (Korean)","Aoede (Mandarin)","Aoede (Russian)","Aoede (Spanish)","Aoede (Thai)","Aoede (Vietnamese)","Ash","Bill","Brian","Callirrhoe (English)","Callirrhoe (Gujarati)","Callirrhoe (Arabic)","Callirrhoe (French)","Callirrhoe (Japanese)","Callirrhoe (Hindi)","Callirrhoe (Korean)","Callirrhoe (Mandarin)","Callirrhoe (Spanish)","Callirrhoe (Thai)","Callirrhoe (Vietnamese)","Callum","Charlie","Charlotte","Charon (English)","Charon (Gujarati)","Charon (Arabic)","Charon (French)","Charon (Japanese)","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 (Arabic)","Fenrir (French)","Fenrir (Japanese)","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 (Arabic)","Kore (French)","Kore (Japanese)","Kore (Hindi)","Kore (Korean)","Kore (Mandarin)","Kore (Russian)","Kore (Spanish)","Kore (Thai)","Kore (Vietnamese)","Laura","Leda (English)","Leda (Gujarati)","Leda (Arabic)","Leda (French)","Leda (Japanese)","Leda (Hindi)","Leda (Korean)","Leda (Mandarin)","Leda (Russian)","Leda (Spanish)","Leda (Thai)","Leda (Vietnamese)","Liam","Lily","Matilda","Nova","Onyx","Orus (English)","Orus (Gujarati)","Orus (Arabic)","Orus (French)","Orus (Japanese)","Orus (Hindi)","Orus (Korean)","Orus (Mandarin)","Orus (Russian)","Orus (Spanish)","Orus (Thai)","Orus (Vietnamese)","Puck (English)","Puck (Gujarati)","Puck (Arabic)","Puck (French)","Puck (Japanese)","Puck (Hindi)","Puck (Korean)","Puck (Mandarin)","Puck (Russian)","Puck (Spanish)","Puck (Thai)","Puck (Vietnamese)","River","Roger","Sarah","Sage","Shimmer","Umbriel (English)","Umbriel (Gujarati)","Umbriel (Arabic)","Umbriel (French)","Umbriel (Japanese)","Umbriel (Hindi)","Umbriel (Korean)","Umbriel (Mandarin)","Umbriel (Spanish)","Umbriel (Thai)","Umbriel (Vietnamese)","Vindemiatrix (English)","Vindemiatrix (Gujarati)","Vindemiatrix (Arabic)","Vindemiatrix (French)","Vindemiatrix (Japanese)","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 (Arabic)","Zephyr (French)","Zephyr (Japanese)","Zephyr (Hindi)","Zephyr (Korean)","Zephyr (Mandarin)","Zephyr (Russian)","Zephyr (Spanish)","Zephyr (Thai)","Zephyr (Vietnamese)","Skylar (US)","Daniel (US)","Linda (US)","Corey (US)","Emma (US)","Ximena (MX)","Fernanda (MX)","Emilio (MX)","Marta (ES)","Mateo (MX)","Minji (KR)","Haeun (KR)","Taehyun (KR)","Jaewon (KR)","Hua (CN)","Liu (CN)","Xia (VN)","Suda (TH)"]
voice_speednumber | nulloptional

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.

voice_pitchnumber | nulloptional

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.

textstringoptional

Text to generate for this voice.

Default
apply_pronunciation_overridesbooleanoptional

Apply TTS pronunciation fixes.

Default false
Request example
{
  "language_code": "string",
  "voice_provider": "string",
  "voice_display_name": "string",
  "voice_speed": "string",
  "voice_pitch": "string",
  "text": "",
  "apply_pronunciation_overrides": false
}

Responses

200Successful Response

application/octet-stream

response string (binary) required
Response example
string
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}