Skip to main content
PATCH

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

actionId
string
required

The action's id (act_…).

Body

application/json

Any field POST takes, plus enabled. Send at least one. The result is validated as it will be saved: a new url is checked against the parameters already there.

name
string

The tool name the agent sees; same rules as on create.

Required string length: 3 - 40
description
string

When the agent should call it (at least 10 characters).

Minimum string length: 10
url
string<uri>

An https:// address with {{placeholders}}.

method
enum<string>

The HTTP method.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
parameters
object[]

Replaces the whole list.

Maximum array length: 20
bodyTemplate
string | null

The JSON body; null removes it.

Maximum string length: 8000
headers
object

Leave it out (or send {}) to keep the saved headers. Sending any replaces the whole set, so include every header the call needs. There is no way to remove all headers short of deleting the action.

speakBefore
string | null

What the agent says while your API is called; null clears it.

Maximum string length: 200
speakAfter
string | null

What the agent says afterwards; null clears it.

Maximum string length: 200
enabled
boolean

true puts the action within reach of every conversation the agent has; false takes it away.

Response

The action as saved.

id
string
required

The action's id (act_…).

agent
string
required

The agent it belongs to (ag_…).

name
string
required

The tool name the agent sees.

description
string
required

When the agent should call it.

method
enum<string>
required

The HTTP method used.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
url
string
required

The https:// address, with {{placeholders}}.

parameters
object[]
required

What the agent fills in.

bodyTemplate
string | null
required

The JSON body sent, with quoted placeholders; null for none.

headerNames
string[]
required

The names of the headers sent. Their values are write-only and never returned.

speakBefore
string | null
required

On calls, what the agent says while your API is being called.

speakAfter
string | null
required

On calls, what the agent says while it turns your answer into a reply.

enabled
boolean
required

Whether the agent may call it. A new action is always false.

createdAt
string<date-time>
required

When it was made.

updatedAt
string<date-time>
required

When it last changed.