Skip to main content
POST
Test Chat

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.

Body

application/json
message
string
required

What the customer says. Trimmed; up to 4,000 characters.

Required string length: 1 - 4000
session
string

The session a previous test chat answered with, to continue that conversation. Leave it out to start a new one.

Pattern: ^vr_[0-9a-f]{32}$

Response

The agent's reply and the tools it used.

session
string
required

Send this back as session to continue the conversation.

Example:

"vr_4f1c09e2b7a84d55a1e0c3b2d9f86a71"

reply
string
required

What the agent said.

tools
object[]
required

Every tool it used, in order.

error
string

Present when the reply failed part-way; reply holds what came before.