TAtavus
Voices

Update Voice

Changed on

Renames, re-describes, or re-tags a voice. Send at least one field. description: null clears it; voice_name and tags have no meaningful empty state, so null is rejected for those.

patch/v2/voices/{voice_id}

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/voices/{voice_id}
  • Auth
    API key in header x-api-key

Path parameters

voice_idstring required

Request body

voice_namestring
descriptionstring nullable
tagsstring[]

Example request

{
  "voice_name": "Ana v2",
  "description": "Warm, unhurried",
  "tags": [
    "support"
  ]
}

Response

voice_idstring

Stable identifier. Use as layers.tts.voice_id on a PAL, or default_voice_id on a face.

voice_namestring
descriptionstring nullable
voice_type'user' | 'system'

user for voices you created, system for the Tavus catalog.

status'started' | 'completed' | 'error'

started while the voice is still being created, completed once it is ready to use, error if creation failed (see error_message).

error_messagestring

Present only when status is error.

tagsstring[]
created_atstring date-time

Example response

{
  "voice_id": "v0a1b2c3d4e5f",
  "voice_name": "Ana",
  "description": "Warm, unhurried, mid-Atlantic",
  "voice_type": "user",
  "status": "completed",
  "tags": [
    "support",
    "en"
  ],
  "created_at": "2026-08-17T12:00:00.000000"
}

Changes