Skip to main content
POST
Preview 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"

Body

application/json
voice
string
required

A voice id from List BYOK Voices.

Maximum string length: 160
agentId
string | null

An agent (ag_…) whose language the line is spoken in when you send no language.

text
string

The line to speak, up to 200 characters. Left out, a short greeting of ours.

Maximum string length: 200
language
string

A language tag such as hi-IN or en, for the line and the voice.

Pattern: ^[A-Za-z]{2,3}([-_][A-Za-z]{2,4})?$

Response

The spoken line. audio/mpeg from most providers; audio/wav from some (Sarvam). Cacheable privately for an hour.

The audio of the spoken line.