Skip to main content
GET
List voices

Authorizations

chariotai-api-key
string
header
required

Your Chariot API key, generated from the dashboard. Send it in the chariotai-api-key header on every request.

Query Parameters

skip
integer
default:0
Required range: x >= 0
limit
integer
default:10
Required range: 1 <= x <= 500
voice_name
string

Case-insensitive substring match on the voice name.

accent
enum<string>
Available options:
american,
british,
indian
gender
enum<string>
Available options:
male,
female,
neutral
sort
enum<string>
default:desc

Sort order by creation time.

Available options:
desc,
asc
offset
integer
default:0

Pagination offset. A nonzero offset takes precedence over skip.

Required range: x >= 0
q
string

Case-insensitive name search. A nonempty q takes precedence over voice_name.

Maximum string length: 200
status
string

Comma-separated lifecycle statuses: draft, processing, failed, published. Deleted voices are never returned. Omit to include all non-deleted statuses.

Maximum string length: 200

Response

The list of voices matching the filters.

data
object[]
total_voices
integer
Example:

8