Skip to main content
PATCH
Update Voice Clone

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The cloned voice's id (vc_…), or its bare voiceId — both name the same voice.

Body

application/json

Any of the three. No other field is accepted.

name
string

A new name, up to 40 characters.

Required string length: 1 - 40
description
string | null

A new note, up to 200 characters, or null to clear it.

Maximum string length: 200
tags
string[]

The new labels, replacing the old. Lower-cased, de-duplicated, eight at most.

Response

The voice after the change.

A voice your workspace cloned.

id
string
required

The clone's id.

Example:

"vc_c4a19e72-0b3d-4f58-a6e1-9d2c7b5f8a03"

voiceId
string
required

What an agent's voice.voice takes — the id List Voices shows it under.

name
string
required

Its name, up to 40 characters.

language
string
required

What it was recorded in, as a language tag: en-IN, hi, ta.

description
string | null
required

A note about it, up to 200 characters.

tags
string[]
required

Lower-case labels such as warm.

Maximum array length: 8
noiseRemoved
boolean
required

Whether background noise was cleaned from the recording before cloning.

previewUrl
string<uri> | null
required

A link to its preview that works for sixty seconds, or null.

usableOnAgents
boolean
required

Whether your plan may put a cloned voice on an agent.

What was agreed to when it was made, and when.

createdAt
string<date-time>
required

When the voice was made.