List Voices
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/agent/voices \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/agent/voices"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/agent/voices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"voices": [
{
"id": "3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d",
"name": "Sarah",
"languages": [
"en-US",
"en-GB"
],
"voice_previews": {
"en-US": "https://example.com/voice-preview-en-us.mp3"
},
"image_url": "https://example.com/voice-avatar.jpg",
"gender": "female",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"updated_at": "2024-12-16T13:03:29.947147+00:00"
}
]
}{
"message": "Invalid credentials"
}{
"status": "error",
"message": "Failed to fetch agent voices"
}List Voices
List the voices you can give an agent, with their supported languages, preview audio and gender, optionally filtered by one or more language codes.
GET
/
agent
/
voices
List Voices
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/agent/voices \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/agent/voices"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/agent/voices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"voices": [
{
"id": "3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d",
"name": "Sarah",
"languages": [
"en-US",
"en-GB"
],
"voice_previews": {
"en-US": "https://example.com/voice-preview-en-us.mp3"
},
"image_url": "https://example.com/voice-avatar.jpg",
"gender": "female",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"updated_at": "2024-12-16T13:03:29.947147+00:00"
}
]
}{
"message": "Invalid credentials"
}{
"status": "error",
"message": "Failed to fetch agent voices"
}Pass the chosen voice’s
id as voice_id when you create an agent or change its voice.
Notes
- A voice works only in the languages listed in its
languages. Pairing a voice with a language it does not support returns400.
Authorizations
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Query Parameters
Filter voices by language (e.g., 'en-US', 'hi-IN'). Multiple languages can be comma-separated.
Response
Successful Response: A list of available voices.
Show child attributes
Show child attributes
Was this page helpful?