Skip to main content
An action is an HTTPS endpoint of yours that the agent may call mid-conversation, with arguments it fills from what the customer said. It is how an agent uses data that stays in your own database. The console’s version is Call your own API.
A new action is off. Test it, then switch it on with PATCH { "enabled": true } — from that moment anybody talking to the agent can cause this call. Sending enabled when creating is refused.

Endpoints

Fields

string
required
The tool name the agent sees: 3–40 characters, lowercase letters, numbers and underscores, starting with a letter. Cannot be one of the agent’s built-in tools.
string
required
When the agent should call it. The model decides from this sentence alone — see the description is the whole thing.
string
required
https:// only, with {{placeholders}} for parameters. Addresses inside private networks are refused when called.
string
default:"GET"
GET, POST, PUT, PATCH or DELETE.
object[]
Up to 20 { name, description, required }. Every placeholder in url and bodyTemplate needs one, and the agent fills them from the conversation.
string
JSON with quoted placeholders — {"id": "{{order_id}}"}. It must still be valid JSON once the blanks are filled.
object
Up to 10, e.g. Authorization. Write-only: stored sealed; only the names come back, as headerNames. On PATCH, leave it out to keep the saved ones — sending any replaces the whole set, so include every header the call needs.
string
On phone calls, what the agent says while the call to your API runs. Up to 200 characters.
string
On phone calls, what it says while it turns your answer into a reply.
boolean
PATCH only. true puts the action within reach of every conversation.
A PATCH is checked against the action as it will be saved — a new URL is checked against the parameters already there.

Test an action

The call is made for real, through exactly the address checks and credentials the agent uses, and works while the action is off. result is what the agent would have read — about 4,000 characters at most. On a POST action the test does the write.

Errors