GET
/
v1
/
shared-voices

Headers

​
xi-api-key
string

Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

Query Parameters

​
page_size
integer
default: 30

How many shared voices to return at maximum. Can not exceed 100, defaults to 30.

​
category
string

voice category used for filtering

​
gender
string

gender used for filtering

​
age
string

age used for filtering

​
accent
string

accent used for filtering

​
language
string

language used for filtering

​
search
string

search term used for filtering

​
use_cases
string[]

use-case used for filtering

​
descriptives
string[]

search term used for filtering

​
featured
boolean
default: false

Filter featured voices

​
reader_app_enabled
boolean
default: false

Filter voices that are enabled for the reader app

​
owner_id
string

Filter voices by public owner ID

​
sort
string

sort criteria

​
page
integer
default: 0

Response

200 - application/json
​
voices
object[]
required
​
has_more
boolean
required
​
last_sort_id
string

Was this page helpful?

Create Voice From Voice PreviewAdd Sharing Voice