Voices

List Voices

Headers

X-API-KeystringRequired
Cartesia-Version"2024-11-13"Required

Query parameters

limitintegerOptionalDefaults to 10

The number of Voices to return per page, ranging between 1 and 100.

starting_afterstringOptional

A cursor to use in pagination. starting_after is a Voice ID that defines your place in the list. For example, if you make a /voices request and receive 100 objects, ending with voice_abc123, your subsequent call can include starting_after=voice_abc123 to fetch the next page of the list.

ending_beforestringOptional

A cursor to use in pagination. ending_before is a Voice ID that defines your place in the list. For example, if you make a /voices request and receive 100 objects, starting with voice_abc123, your subsequent call can include ending_before=voice_abc123 to fetch the previous page of the list.

is_ownerbooleanOptional

Whether to only return voices owned by the current user.

is_starredbooleanOptional

Whether to only return starred voices.

genderenumOptional

The gender presentation of the voices to return.

Allowed values:
expand[]list of enumsOptional

Additional fields to include in the response.

Allowed values:

Response

This endpoint returns an object.
datalist of objects

The paginated list of Voices.

has_moreboolean

Whether there are more Voices to fetch (using starting_after=id, where id is the ID of the last Voice in the current response).

next_pagestringOptional

(Deprecated - use the id of the last Voice in the current response instead.) An ID that can be passed as starting_after to get the next page of Voices.