Connect the agent to your system

An API tool lets the AI agent call your own system during a chat. A customer gives an order number; the agent replies with its shipping status.

Inboxes → your inbox → AI agent → API Tools

1. Click New API.
2. What it does: give it a Name, like "Check order status", and fill in When should the AI use it?. The agent reads this to decide when to call it.
3. Connect: pick the Method and type the Address. Put the parts that change in curly brackets, like https://api.yourshop.com/orders/{order_number}. Or click paste a cURL command, paste one from your developer, and click Fill in. Choose a Sign-in and enter the key or token.
4. Inputs: click Add input. For each one, set Value comes from:
   • Customer: the agent asks for it in the chat. Describe it in What it is, so the AI can ask for it.
   • Pre-chat form: taken from a question on your pre-chat form.
   • Fixed value: sent as typed on every call.
5. Test it: click Run test. Then tick the parts of the response the agent may read. The rest stays Private.
6. How the AI should reply: say what to tell the customer, like "Say the status and when it should arrive."
7. Click Save API.

Good to knowCopy Anchor Link

• For a call that changes something, like cancelling an order, tick Ask the customer to confirm first. Recommended when it changes something. The agent then says what will change and waits for a yes.
• Saved keys and tokens show only as dots.
• The AI can use this switch turns a tool on or off without deleting it.
• After saving, Create API form turns the tool into an in-chat form that uses no AI credits.
• A partner may have set some API tools up for you. Their connection and inputs are read-only.