Skip to main content
PUT

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 agent's id (ag_…), as List Agents returns it. Another workspace's agent is the same 404 as one that never existed.

Body

application/json

Every field is optional, one at least. A key left out keeps what is saved, null resets it, a value sets it.

voice
string | null

A voice id from List BYOK Voices, or null for the provider's default (which clears the settings below).

Maximum string length: 160
speed
number | null

Cartesia only. How fast the voice speaks; 1 is Cartesia's own. Needs a Sonic 3 model. Does not apply to a Professional Voice Clone.

Required range: 0.6 <= x <= 1.5
volume
number | null

Cartesia only. How loud the voice is; 1 is Cartesia's own. Needs a Sonic 3 model.

Required range: 0.5 <= x <= 2
emotion
string | null

Cartesia only. One of Cartesia's emotions, for example neutral, calm, content, sad, angry, scared, happy, excited. Works in English only. Needs a Sonic 3 model.

model
enum<string> | null

Cartesia only. The Sonic model this agent speaks on; null uses your key's model.

Available options:
sonic-3.6,
sonic-3.6-2026-08-27,
sonic-3.5,
sonic-3,
sonic-2,
null
pronunciationDictId
string | null

Cartesia only. The id Cartesia gave a pronunciation dictionary in your account; null for none.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{2,79}$

Response

The voice saved on the agent, with the provider it belongs to, and its settings (null while unset). The voice and provider are null after choosing the default.

voice
string | null
required

The voice saved, or null for the provider's default.

provider
string | null
required

The provider id the voice belongs to, or null with the default.

speed
number | null

Cartesia only: the speed now saved, or null.

volume
number | null

Cartesia only: the volume now saved, or null.

emotion
string | null

Cartesia only: the emotion now saved, or null.

agentModel
string | null

Cartesia only: the Sonic model now saved for this agent (the request's model), or null.

pronunciationDictId
string | null

Cartesia only: the dictionary id now saved, or null.