Update Voice

curl --request PATCH \
  --url https://api.cartesia.ai/voices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "gender": "masculine"
}
'

{
  "id": "<string>",
  "is_owner": true,
  "is_public": false,
  "name": "<string>",
  "description": "<string>",
  "language": "en",
  "created_at": "2024-11-04T05:31:56Z"
}

PATCH

voices

{id}

Update Voice

curl --request PATCH \
  --url https://api.cartesia.ai/voices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "gender": "masculine"
}
'

{
  "id": "<string>",
  "is_owner": true,
  "is_public": false,
  "name": "<string>",
  "description": "<string>",
  "language": "en",
  "created_at": "2024-11-04T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Cartesia API key

Headers

Cartesia-Version

enum<string>

required

API version header. Must be set to the API version, e.g. '2024-06-10'.

Available options:

2024-06-10,

2024-11-13,

2025-04-16

Example:

"2025-04-16"

Path Parameters

string

required

The ID of the voice.

Body

application/json

name

string

required

The name of the voice.

description

string

required

The description of the voice.

gender

enum<string> | null

Available options:

masculine,

feminine,

gender_neutral

Response

200 - application/json

string

required

The ID of the voice.

is_owner

boolean

required

Whether your organization owns the voice.

is_public

boolean

required

Whether the voice is publicly accessible.

name

string

required

The name of the voice.

description

string

required

The description of the voice.

created_at

string<date-time>

required

The date and time the voice was created.

language

enum<string>

required

The language that the given voice should speak the transcript in. For valid options, see Models.

Available options:

en,

fr,

de,

es,

pt,

zh,

ja,

hi,

it,

ko,

nl,

pl,

ru,

sv,

tr,

tl,

bg,

ro,

ar,

cs,

el,

fi,

hr,

ms,

sk,

da,

ta,

uk,

hu,

no,

vi,

bn,

th,

he,

ka,

id,

te,

gu,

kn,

ml,

mr,

pa

gender

enum<string> | null

The gender of the voice, if specified.

Available options:

masculine,

feminine,

gender_neutral

preview_file_url

string | null

A URL to download a preview audio file for this voice. Useful to avoid consuming credits when looking for the right voice. The URL requires the same Authorization header. Voice previews may be changed, moved, or deleted so you should avoid storing the URL permanently. This property will be null if there's no preview available. Only included when expand[] includes preview_file_url.

⌘I