Skip to main content
GET
Get 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. 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.

Response

The agent's voice on your provider.

provider
object
required

One of your own providers.

model
string | null
required

The model your voice key runs.

voice
string | null
required

The voice this agent speaks with on this provider, or null for the provider's default.

stale
object | null
required

A choice made on a different provider, which no longer applies; null when there is none.

speed
number | null

Cartesia only: the speed set for this agent (0.6 to 1.5), or null for Cartesia's own.

volume
number | null

Cartesia only: the volume set for this agent (0.5 to 2.0), or null for Cartesia's own.

emotion
string | null

Cartesia only: the emotion set for this agent (English only), or null to let the words decide.

agentModel
string | null

Cartesia only: the Sonic model this agent speaks on instead of your key's model, or null for the key's.

pronunciationDictId
string | null

Cartesia only: the pronunciation dictionary used for this agent, or null for none.