Skip to main content
GET
Get BYOK Status

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"

Response

The workspace's BYOK state.

enabled
boolean
required

Whether this workspace has switched its own keys on.

scope
enum<string>
required

What this workspace brings: all — speech-to-text, LLM and voice keys (a call is ₹1/min all-in, a chat reply ₹0.02); voice — only the voice key, with our speech-to-text, model and telephony (a call is billed at the voice-only BYOK rate, replies as usual); llm — only the language-model key, with our speech-to-text and voice (a call is billed on the same Premium or Studio voice plan as any call, a chat reply at ₹0.02); llm_voice — the language-model key and the voice key, with our speech recogniser (a call is a flat ₹1/min like all, no model limit, a chat reply at ₹0.02). It is the default for your agents; an agent may choose its own (byok on the agent). all unless changed.

Available options:
all,
voice,
llm,
llm_voice
usingScope
enum<string> | null
required

The scope that applies right now — a customer inheriting runs on its developer's scope — or null when no keys apply.

Available options:
all,
voice,
llm,
llm_voice,
null
using
enum<string>
required

Whose keys calls and replies use right now: this workspace's, its developer's (a customer inheriting them), or none.

Available options:
own,
developer,
none
complete
boolean
required

Whether this workspace's own keys for its scope are verified and each has a model — what turning BYOK on needs (all three under all, the voice key under voice, the LLM key under llm, the LLM and voice keys under llm_voice).

credentials
object[]
required

This workspace's own keys, masked.