Update Voice

PATCH

Path parameters

idstringRequired

The ID of the voice.

Headers

Auth
X-API-KeystringRequired
Cartesia-Version"2024-06-10"RequiredDefaults to 2024-06-10

Request

This endpoint expects an object.
namestringRequired

The name of the voice.

descriptionstringRequired

The description of the voice.

Response

This endpoint returns an object.
idstring

The ID of the voice.

user_idstring

The ID of the user who owns 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.

embeddinglist of doubles

A 192-dimensional vector (i.e. a list of 192 numbers) that represents the voice.

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).

base_voice_idstringOptional

The ID of the base voice associated with the voice, used for features like voice mixing.

Get Voice
Built with