Skip to main content
A custom tool lets the AI agent call one of your own web APIs. The agent can then answer with live facts, such as “Your order shipped yesterday,” instead of a general reply.
This page is best set up with help from a developer. You need an API address and, usually, a key.

​
How it works

  1. You describe the tool and what it is for.
  2. During a chat, the agent decides if the tool fits the question.
  3. It collects any details it needs, such as an order number.
  4. It calls your API and uses the result in its reply.
The agent picks tools using your name and description, so write them clearly.

​
Add a tool

1

Open custom tools

Go to the AI section, then Tools, then custom tools, and add a new tool.
2

Describe the tool

Give it a clear name and say when to use it. For example: “Look up the delivery status of an order. Use when a customer asks where their package is.”
3

Enter the request details

Choose the request type and enter your API address.
4

Set up authentication

Pick how your API checks who is calling, and add the key or token.
5

Add headers (optional)

Add any fixed headers your API needs.
6

Define the inputs

For each input, give a name, say whether it is required, and explain where the agent can find it, such as “the order number the customer mentions.”
7

Describe the response (optional)

Explaining what your API returns can help the agent read it correctly.
8

Save and switch it on

Only active tools are used. You can switch a tool off without deleting it.

​
Check how it is used

Your team can review the calls the agent made, with the inputs and results.
Never give the agent a tool that can do something you would not want done by mistake, like issuing a refund, unless your rules are very clear. The agent can misread a request.