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.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Response

The workspace's BYOK state.

enabled
boolean
required

Whether this workspace has switched its own keys on.

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 three keys are verified and each has a model — what turning BYOK on needs.

credentials
object[]
required

This workspace's own keys, masked.