ADMINISTRATIONVoice Library

Get shared voices

Retrieves a list of shared voices.

Headers

xi-api-keystringOptional

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:
genderstringOptional

Gender used for filtering

agestringOptional

Age used for filtering

accentstringOptional

Accent used for filtering

languagestringOptional

Language used for filtering

localestringOptional

Locale used for filtering

searchstringOptional

Search term used for filtering

use_casesstringOptional

Use-case used for filtering

descriptivesstringOptional

Search term used for filtering

featuredbooleanOptionalDefaults to false

Filter featured voices

min_notice_period_daysintegerOptional

Filter voices with a minimum notice period of the given number of days.

include_custom_ratesbooleanOptional

Include/exclude voices with custom rates

include_live_moderatedbooleanOptional

Include/exclude voices that are live moderated

reader_app_enabledbooleanOptionalDefaults to false

Filter voices that are enabled for the reader app

owner_idstringOptional

Filter voices by public owner ID

sortstringOptional

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_idstringOptional

Errors