Get shared voices
Retrieves the shared voices built into a TTS model, optionally filtered by gender, age, accent, use case and style. All given filters must match. For the voices you have cloned yourself, see `GET /v1/voices` instead.
Retrieves the shared voices built into a TTS model, optionally filtered by gender, age, accent, use case and style. All given filters must match. For the voices you have cloned yourself, see GET /v1/voices instead.
Headers
AuthorizationRequiredBearer <SONIOX_API_KEY>Query parameters
modelRequiredstringId of the TTS model whose voices to return.
64genderstringOnly return voices of this gender.
agestringOnly return voices of this age.
accentstringOnly return voices with this accent.
40use_casearray<string>Only return voices tagged with every listed use case. Repeat the parameter to pass several values, or separate them with commas.
stylearray<string>Only return voices tagged with every listed style. Repeat the parameter to pass several values, or separate them with commas.
limitintegerMaximum number of voices to return.
100Minimum: 1Maximum: 200cursorstringPagination cursor for the next page of results. Pass the same filters alongside it; the cursor points into the filtered list, not the whole catalogue.
Response
200
List of shared voices matching the filters.
voicesRequiredarray<object>List of voices matching the filters.
next_page_cursorstringA pagination token that references the next page of results. When more data is available, this field contains a value to pass in the cursor parameter of a subsequent request. When null, no additional results are available.
Errors
List of shared voices matching the filters.
{
"voices": [
{
"id": "Maya",
"description": "A steady, clear voice with a natural presence and measured delivery that feels confident, warm, and easy to listen to.",
"gender": "female",
"age": "middle_aged",
"accent": "british",
"use_case": [
"conversational"
],
"style": [
"smooth",
"confident",
"neutral"
]
},
{
"id": "Victoria",
"description": "A poised female voice with a refined British accent, smooth pacing, and a lightly textured tone that feels elegant, confident, and composed.",
"gender": "female",
"age": "middle_aged",
"accent": "british",
"use_case": [
"educational",
"narration",
"conversational"
],
"style": [
"formal",
"bright",
"confident",
"neutral",
"calm"
]
}
],
"next_page_cursor": "cursor_or_null"
}