Voices

Update Voice

Update the name, description, and gender of a voice. To set the gender back to the default, set the gender to null. If gender is not specified, the gender will not be updated.

Path parameters

idstringRequired
The ID of the voice.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Cartesia-Version"2025-04-16"Required

Request

This endpoint expects an object.
namestringRequired
The name of the voice.
descriptionstringRequired
The description of the voice.
genderenumOptional
Allowed values:

Response

This endpoint returns an object.
idstring
The ID of the voice.
is_ownerboolean
Whether the current user is the owner of the voice.
is_publicboolean
Whether the voice is publicly accessible.
namestring
The name of the voice.
descriptionstring
The description of the voice.
created_atdatetime
The date and time the voice was created.
languageenum

The language that the given voice should speak the transcript in.

Options: English (en), French (fr), German (de), Spanish (es), Portuguese (pt), Chinese (zh), Japanese (ja), Hindi (hi), Italian (it), Korean (ko), Dutch (nl), Polish (pl), Russian (ru), Swedish (sv), Turkish (tr).

genderenum or null
The gender of the voice, if specified.
Allowed values:
is_starredboolean or null

Whether the current user has starred the voice. Only included when expand includes is_starred.