Skip to main content
GET
List Built-in Tools

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_…).

Response

The built-in tools.

agent
string
required

The agent (ag_…).

tools
object[]
required

Searching the web. Shown, never switchable here.

recall
enum<string>
required

How much of a recognised customer's history from other channels the agent may use.

Available options:
trusted,
two_tier,
verified
verifyByCode
boolean
required

Whether a customer is confirmed with a one-time WhatsApp code rather than their email.

knowledgeOnCalls
boolean
required

Whether the agent searches its knowledge during phone and web calls. On unless you switch it off; chat is not affected.

handOver
object
required

How a hand-over to a person happens.