Skip to main content
PATCH
Update Voice
For AI agents, use https://docs.tavus.io/openapi.yaml for the full HTTP API contract.

Authorizations

x-api-key
string
header
required

Path Parameters

voice_id
string
required

Body

application/json
voice_name
string
Required string length: 1 - 255
Example:

"Ana v2"

description
string | null
Maximum string length: 1000
Example:

"Warm, unhurried"

tags
string[]
Maximum array length: 50
Maximum string length: 64
Example:

Response

A Tavus Voice. Reference it by voice_id; Tavus picks the provider that is the best fit for the language(s) of the conversation.

voice_id
string

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

Example:

"v0a1b2c3d4e5f"

voice_name
string
Example:

"Ana"

description
string | null
Example:

"Warm, unhurried, mid-Atlantic"

voice_type
enum<string>

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

Available options:
user,
system
Example:

"user"

status
enum<string>

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

Available options:
started,
completed,
error
Example:

"completed"

error_message
string

Present only when status is error.

tags
string[]
Example:
created_at
string<date-time>
Example:

"2026-08-17T12:00:00.000000"