v1

latestOpenAPI 3.0.12026-07-2696152184.1 KB

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.

patch/voices/{id}

Path parameters

idstring required

The ID of the voice. Find one in the Voice Library or via List Voices.

Headers

Cartesia-Version'2026-03-01' date required

Example:2026-03-01

API version header.

Request body

namestring

The name of the voice.

taglinestring

A few words describing the voice. At most 32 characters.

descriptionstring

A description for the voice, typically longer than the tagline if both are provided.

gender'masculine' | 'feminine' | 'gender_neutral'

Response

idstring required

The ID of the voice. Find one in the Voice Library or via List Voices.

is_ownerboolean required

Whether your organization owns the voice.

namestring required

The display name of the voice. Does not include the tagline.

taglinestring required

A short descriptor for the voice (at most 32 characters). Empty string when unset.

descriptionstring required

A description for the voice, typically longer than the tagline if both are provided.

gender'masculine' | 'feminine' | 'gender_neutral'

created_atstring date-time required

The date and time the voice was created.

preview_file_urlstring nullable

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.

languagestring required

The voice's language, as an ISO 639-1 code (e.g. en, fr, zh)

countrystring

The country associated with the voice, as an ISO 3166-1 alpha-2 code when available (e.g. US, GB, FR).

is_proboolean

Whether this voice is a pro voice clone.

is_publicboolean required

Use access instead. Whether the voice is publicly accessible.

modestring

No longer used.

Example response

{
  "id": "db6b0ed5-d5d3-463d-ae85-518a07d3c2b4",
  "is_owner": false,
  "access": {
    "type": "public",
    "visibility": "all"
  },
  "name": "Skylar",
  "tagline": "Friendly Guide",
  "description": "Approachable American female ideal for customer care and support.",
  "gender": "feminine",
  "language": "en",
  "country": "US",
  "created_at": "2026-03-31T17:37:05.961874Z",
  "is_public": true
}