Skip to main content
GET
Get Agent

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"

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.

An agent as the console shows it.

id
string
required

The agent's id.

Example:

"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71"

name
string
required

The agent's name, 2 to 60 characters.

instructions
string
required

What the agent is and how it behaves — its standing prompt.

greeting
string
required

The first thing it says, or an empty string.

businessDescription
string
required

One line about the business, or an empty string.

model
string | null
required

A model id from List Models. null when the agent is on a model that has since been retired.

temperature
number
required

How adventurous the wording is.

Required range: 0 <= x <= 2
maxReplyTokens
integer
required

The longest a reply may be, in tokens — one ceiling for chat and calls.

Required range: 100 <= x <= 800
language
string
required

auto (reply in the customer's language) or the language it always replies in, e.g. Hindi.

secondLanguage
string | null
required

A second language it may switch to, or null.

escalation
object
required

When the agent hands the conversation to a person on your team.

captureLeads
boolean
required

Whether it takes a name, email or phone number from an interested customer.

scheduleCallbacks
boolean
required

Whether it may book a call back when asked.

steps
object[]
required

Its conversation script, in order.

widget
object
required

The website chat widget's look.

voice
object | null
required

How it handles calls. null when the agent has no voice channel (a deployment without voice).

collectFields
object[]
required

The details it fills in after every call, in the shape a call's extract takes. Empty when it collects nothing.

webKey
string | null
required

The public key the website widget embeds (pk_…). It is published on your site, so it is not a secret.

createdAt
string<date-time>
required

When the agent was made.