Skip to main content
PUT
Set Agent BYOK Voice

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.

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
voice
string | null
required

A voice id from List BYOK Voices, or null for the provider's default.

Maximum string length: 160

Response

The voice saved on the agent, with the provider it belongs to. Both 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.