Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.agents.agentGetAvailableVoices({});
console.log(result);
}
run();import os
from syllable_sdk import SyllableSDK
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.agents.agent_get_available_voices()
# Handle response
print(res)curl --request GET \
--url https://api.syllable.cloud/api/v1/agents/voices/available \
--header 'Syllable-API-Key: <api-key>'const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};
fetch('https://api.syllable.cloud/api/v1/agents/voices/available', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.syllable.cloud/api/v1/agents/voices/available",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Syllable-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.syllable.cloud/api/v1/agents/voices/available"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Syllable-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syllable.cloud/api/v1/agents/voices/available")
.header("Syllable-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syllable.cloud/api/v1/agents/voices/available")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"provider": "OpenAI",
"display_name": "Alloy",
"var_name": "openai:alloy",
"gender": "male",
"model": "tts-1",
"supported_languages": {
"code": "en-US",
"name": "English"
},
"deprecated": false,
"sunset_date": null,
"removed": false,
"fallback": null,
"status": "active"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}agents
Get Available Agent Voices
Get available agent voices.
Each voice’s status is resolved against the current date. Retired voices are omitted unless
their display name is passed in selected_voice, so a saved config still referencing a retired
voice can render it as a locked field. A voice group holds one voice per language, so the
parameter is repeatable.
GET
/
api
/
v1
/
agents
/
voices
/
available
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";
const syllableSDK = new SyllableSDK({
apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});
async function run() {
const result = await syllableSDK.agents.agentGetAvailableVoices({});
console.log(result);
}
run();import os
from syllable_sdk import SyllableSDK
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.agents.agent_get_available_voices()
# Handle response
print(res)curl --request GET \
--url https://api.syllable.cloud/api/v1/agents/voices/available \
--header 'Syllable-API-Key: <api-key>'const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};
fetch('https://api.syllable.cloud/api/v1/agents/voices/available', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.syllable.cloud/api/v1/agents/voices/available",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Syllable-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.syllable.cloud/api/v1/agents/voices/available"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Syllable-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syllable.cloud/api/v1/agents/voices/available")
.header("Syllable-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syllable.cloud/api/v1/agents/voices/available")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"provider": "OpenAI",
"display_name": "Alloy",
"var_name": "openai:alloy",
"gender": "male",
"model": "tts-1",
"supported_languages": {
"code": "en-US",
"name": "English"
},
"deprecated": false,
"sunset_date": null,
"removed": false,
"fallback": null,
"status": "active"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Query Parameters
Response
Successful Response
The provider for the voice
Available options:
OpenAI, ElevenLabs, Google, Cartesia Example:
"OpenAI"
The display name of the voice
Available options:
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) Example:
"Alloy"
The variable name of the voice (used when processing messages)
Available options:
openai:alloy, openai:ash, openai:coral, openai:echo, openai:fable, openai:nova, openai:onyx, openai:sage, openai:shimmer, elevenlabs:Alice, elevenlabs:Bill, elevenlabs:Brian, elevenlabs:Callum, elevenlabs:Charlie, elevenlabs:Charlotte, elevenlabs:Chris, elevenlabs:Daniel, elevenlabs:Eric, elevenlabs:George, elevenlabs:Jessica, elevenlabs:Laura, elevenlabs:Liam, elevenlabs:Lily, elevenlabs:Matilda, elevenlabs:River, elevenlabs:Roger, elevenlabs:Sarah, elevenlabs:Will, wavenet:female/en-US-Chirp3-HD-Achernar, wavenet:female/gu-IN-Chirp3-HD-Achernar, wavenet:female/ar-XA-Chirp3-HD-Achernar, wavenet:female/fr-FR-Chirp3-HD-Achernar, wavenet:female/ja-JP-Chirp3-HD-Achernar, wavenet:female/hi-IN-Chirp3-HD-Achernar, wavenet:female/ko-KR-Chirp3-HD-Achernar, wavenet:female/cmn-CN-Chirp3-HD-Achernar, wavenet:female/es-US-Chirp3-HD-Achernar, wavenet:female/th-TH-Chirp3-HD-Achernar, wavenet:female/vi-VN-Chirp3-HD-Achernar, wavenet:female/en-US-Chirp3-HD-Aoede, wavenet:female/gu-IN-Chirp3-HD-Aoede, wavenet:female/ar-XA-Chirp3-HD-Aoede, wavenet:female/fr-FR-Chirp3-HD-Aoede, wavenet:female/ja-JP-Chirp3-HD-Aoede, wavenet:female/hi-IN-Chirp3-HD-Aoede, wavenet:female/ko-KR-Chirp3-HD-Aoede, wavenet:female/cmn-CN-Chirp3-HD-Aoede, wavenet:female/ru-RU-Chirp3-HD-Aoede, wavenet:female/es-US-Chirp3-HD-Aoede, wavenet:female/th-TH-Chirp3-HD-Aoede, wavenet:female/vi-VN-Chirp3-HD-Aoede, wavenet:male/es-US-Neural2-B, wavenet:female/en-US-Chirp3-HD-Callirrhoe, wavenet:female/gu-IN-Chirp3-HD-Callirrhoe, wavenet:female/ar-XA-Chirp3-HD-Callirrhoe, wavenet:female/fr-FR-Chirp3-HD-Callirrhoe, wavenet:female/ja-JP-Chirp3-HD-Callirrhoe, wavenet:female/hi-IN-Chirp3-HD-Callirrhoe, wavenet:female/ko-KR-Chirp3-HD-Callirrhoe, wavenet:female/cmn-CN-Chirp3-HD-Callirrhoe, wavenet:female/es-US-Chirp3-HD-Callirrhoe, wavenet:female/th-TH-Chirp3-HD-Callirrhoe, wavenet:female/vi-VN-Chirp3-HD-Callirrhoe, wavenet:male/en-US-Chirp3-HD-Charon, wavenet:male/gu-IN-Chirp3-HD-Charon, wavenet:male/ar-XA-Chirp3-HD-Charon, wavenet:male/fr-FR-Chirp3-HD-Charon, wavenet:male/ja-JP-Chirp3-HD-Charon, wavenet:male/hi-IN-Chirp3-HD-Charon, wavenet:male/ko-KR-Chirp3-HD-Charon, wavenet:male/cmn-CN-Chirp3-HD-Charon, wavenet:male/ru-RU-Chirp3-HD-Charon, wavenet:male/es-US-Chirp3-HD-Charon, wavenet:male/th-TH-Chirp3-HD-Charon, wavenet:male/vi-VN-Chirp3-HD-Charon, wavenet:female/en-US-Neural2-F, wavenet:male/en-US-Chirp3-HD-Fenrir, wavenet:male/gu-IN-Chirp3-HD-Fenrir, wavenet:male/ar-XA-Chirp3-HD-Fenrir, wavenet:male/fr-FR-Chirp3-HD-Fenrir, wavenet:male/ja-JP-Chirp3-HD-Fenrir, wavenet:male/hi-IN-Chirp3-HD-Fenrir, wavenet:male/ko-KR-Chirp3-HD-Fenrir, wavenet:male/cmn-CN-Chirp3-HD-Fenrir, wavenet:male/ru-RU-Chirp3-HD-Fenrir, wavenet:male/es-US-Chirp3-HD-Fenrir, wavenet:male/th-TH-Chirp3-HD-Fenrir, wavenet:male/vi-VN-Chirp3-HD-Fenrir, wavenet:female/es-US-Neural2-A, wavenet:male/en-US-Neural2-D, wavenet:female/en-US-Chirp3-HD-Kore, wavenet:female/gu-IN-Chirp3-HD-Kore, wavenet:female/ar-XA-Chirp3-HD-Kore, wavenet:female/fr-FR-Chirp3-HD-Kore, wavenet:female/ja-JP-Chirp3-HD-Kore, wavenet:female/hi-IN-Chirp3-HD-Kore, wavenet:female/ko-KR-Chirp3-HD-Kore, wavenet:female/cmn-CN-Chirp3-HD-Kore, wavenet:female/ru-RU-Chirp3-HD-Kore, wavenet:female/es-US-Chirp3-HD-Kore, wavenet:female/th-TH-Chirp3-HD-Kore, wavenet:female/vi-VN-Chirp3-HD-Kore, wavenet:female/en-US-Chirp3-HD-Leda, wavenet:female/gu-IN-Chirp3-HD-Leda, wavenet:female/ar-XA-Chirp3-HD-Leda, wavenet:female/fr-FR-Chirp3-HD-Leda, wavenet:female/ja-JP-Chirp3-HD-Leda, wavenet:female/hi-IN-Chirp3-HD-Leda, wavenet:female/ko-KR-Chirp3-HD-Leda, wavenet:female/cmn-CN-Chirp3-HD-Leda, wavenet:female/ru-RU-Chirp3-HD-Leda, wavenet:female/es-US-Chirp3-HD-Leda, wavenet:female/th-TH-Chirp3-HD-Leda, wavenet:female/vi-VN-Chirp3-HD-Leda, wavenet:female/cmn-TW-Wavenet-A, wavenet:male/en-US-Neural2-J, wavenet:female/yue-HK-Standard-C, wavenet:female/en-US-Studio-O, wavenet:male/en-US-Chirp3-HD-Orus, wavenet:male/gu-IN-Chirp3-HD-Orus, wavenet:male/ar-XA-Chirp3-HD-Orus, wavenet:male/fr-FR-Chirp3-HD-Orus, wavenet:male/ja-JP-Chirp3-HD-Orus, wavenet:male/hi-IN-Chirp3-HD-Orus, wavenet:male/ko-KR-Chirp3-HD-Orus, wavenet:male/cmn-CN-Chirp3-HD-Orus, wavenet:male/ru-RU-Chirp3-HD-Orus, wavenet:male/es-US-Chirp3-HD-Orus, wavenet:male/th-TH-Chirp3-HD-Orus, wavenet:male/vi-VN-Chirp3-HD-Orus, wavenet:male/en-US-Chirp3-HD-Puck, wavenet:male/gu-IN-Chirp3-HD-Puck, wavenet:male/ar-XA-Chirp3-HD-Puck, wavenet:male/fr-FR-Chirp3-HD-Puck, wavenet:male/ja-JP-Chirp3-HD-Puck, wavenet:male/hi-IN-Chirp3-HD-Puck, wavenet:male/ko-KR-Chirp3-HD-Puck, wavenet:male/cmn-CN-Chirp3-HD-Puck, wavenet:male/ru-RU-Chirp3-HD-Puck, wavenet:male/es-US-Chirp3-HD-Puck, wavenet:male/th-TH-Chirp3-HD-Puck, wavenet:male/vi-VN-Chirp3-HD-Puck, wavenet:female/ko-KR-Neural2-A, wavenet:female/vi-VN-Neural2-A, wavenet:male/en-US-Chirp3-HD-Umbriel, wavenet:male/gu-IN-Chirp3-HD-Umbriel, wavenet:male/ar-XA-Chirp3-HD-Umbriel, wavenet:male/fr-FR-Chirp3-HD-Umbriel, wavenet:male/ja-JP-Chirp3-HD-Umbriel, wavenet:male/hi-IN-Chirp3-HD-Umbriel, wavenet:male/ko-KR-Chirp3-HD-Umbriel, wavenet:male/cmn-CN-Chirp3-HD-Umbriel, wavenet:male/es-US-Chirp3-HD-Umbriel, wavenet:male/th-TH-Chirp3-HD-Umbriel, wavenet:male/vi-VN-Chirp3-HD-Umbriel, wavenet:female/en-US-Chirp3-HD-Vindemiatrix, wavenet:female/gu-IN-Chirp3-HD-Vindemiatrix, wavenet:female/ar-XA-Chirp3-HD-Vindemiatrix, wavenet:female/fr-FR-Chirp3-HD-Vindemiatrix, wavenet:female/ja-JP-Chirp3-HD-Vindemiatrix, wavenet:female/hi-IN-Chirp3-HD-Vindemiatrix, wavenet:female/ko-KR-Chirp3-HD-Vindemiatrix, wavenet:female/cmn-CN-Chirp3-HD-Vindemiatrix, wavenet:female/es-US-Chirp3-HD-Vindemiatrix, wavenet:female/th-TH-Chirp3-HD-Vindemiatrix, wavenet:female/vi-VN-Chirp3-HD-Vindemiatrix, wavenet:female/en-US-Chirp3-HD-Zephyr, wavenet:female/gu-IN-Chirp3-HD-Zephyr, wavenet:female/ar-XA-Chirp3-HD-Zephyr, wavenet:female/fr-FR-Chirp3-HD-Zephyr, wavenet:female/ja-JP-Chirp3-HD-Zephyr, wavenet:female/hi-IN-Chirp3-HD-Zephyr, wavenet:female/ko-KR-Chirp3-HD-Zephyr, wavenet:female/cmn-CN-Chirp3-HD-Zephyr, wavenet:female/ru-RU-Chirp3-HD-Zephyr, wavenet:female/es-US-Chirp3-HD-Zephyr, wavenet:female/th-TH-Chirp3-HD-Zephyr, wavenet:female/vi-VN-Chirp3-HD-Zephyr, cartesia:Skylar, cartesia:Daniel, cartesia:Linda, cartesia:Corey, cartesia:Emma, cartesia:Ximena, cartesia:Fernanda, cartesia:Emilio, cartesia:Marta, cartesia:Mateo, cartesia:Minji, cartesia:Haeun, cartesia:Taehyun, cartesia:Jaewon, cartesia:Hua, cartesia:Liu, cartesia:Xia, cartesia:Suda Example:
"openai:alloy"
The gender of the voice
Available options:
female, male Example:
"male"
The model of the voice
Available options:
Chirp 3 HD, eleven_flash_v2_5, Neural2, Standard, Studio, WaveNet, tts-1, gpt-4o-mini-tts, sonic-3.5 Example:
"tts-1"
Languages supported by the voice
Show child attributes
Show child attributes
Example:
{ "code": "en-US", "name": "English" }
Whether the voice is in the deprecation warning window
Example:
false
Date the voice becomes retired and can no longer be saved or selected
Example:
null
Whether the voice is force-retired regardless of sunset_date
Example:
false
Voice substituted at runtime for critical features once this one is retired
Example:
null
Effective lifecycle status, resolved server-side against the current date. Populated on API responses; unset in the static catalog.
Available options:
active, deprecated, retired Example:
"active"