Skip to main content
An API tool lets your agent fetch or send data during a call. For example, it can check stock, book a slot or look up a loyalty balance. You need a public https:// endpoint that answers within 30 seconds.
1

Create the tool

Send the endpoint, method, any auth header and the values the agent should collect.
Save tool.id from the response.
2

Attach it to an agent

In the dashboard, open the agent, go to Knowledge & tools, select the tool and save.
3

Tell the agent when to use it

Add a line to the agent’s instructions, like “If the customer asks about stock, check it before answering.”
4

Test it

Chat with the agent and ask a question that needs the tool.

​
What your API receives

By default, the parameters the agent collected plus your preset values, as JSON. To control the exact body, set bodyTemplate:
What your API returns is read by the agent. Keep it short and plain, like { "in_stock": true, "price": 1299 }.

​
Tips

  • Mark API keys secret: true. They are never shown again.
  • Write description as a rule: when to use the tool, not what it is.
  • Set speakWhileWaiting for slow APIs so the customer isn’t left in silence.
  • Use presetParameters with {{call.phone_number}} to send the caller’s number without asking.

API reference

Every field, with examples.