ADMINISTRATIONVoice Library

Get shared voices

Retrieves a list of shared voices.

Headers

xi-api-keystringRequired

Query parameters

page_sizeintegerOptionalDefaults to 30
How many shared voices to return at maximum. Can not exceed 100, defaults to 30.
categoryenumOptional
Voice category used for filtering
Allowed values:
genderstring or nullOptional
Gender used for filtering
agestring or nullOptional
Age used for filtering
accentstring or nullOptional
Accent used for filtering
languagestring or nullOptional
Language used for filtering
localestring or nullOptional
Locale used for filtering
searchstring or nullOptional
Search term used for filtering
use_caseslist of strings or nullOptional

Use-case used for filtering

descriptiveslist of strings or nullOptional
Search term used for filtering
featuredbooleanOptionalDefaults to false
Filter featured voices
min_notice_period_daysinteger or nullOptional
Filter voices with a minimum notice period of the given number of days.
include_custom_ratesboolean or nullOptional

Include/exclude voices with custom rates

include_live_moderatedboolean or nullOptional

Include/exclude voices that are live moderated

reader_app_enabledbooleanOptionalDefaults to false
Filter voices that are enabled for the reader app
owner_idstring or nullOptional
Filter voices by public owner ID
sortstring or nullOptional
Sort criteria
pageintegerOptionalDefaults to 0

Response

Successful Response
voiceslist of objects
The list of shared voices
has_moreboolean
Whether there are more shared voices in subsequent pages.
last_sort_idstring or null

Errors