API tools let the AI in a SnapCall Flow fetch live data from your own systems, such as your helpdesk or product catalogue, while it analyses a customer's media.
What is an API tool?
An API tool is an HTTP request that the AI Skills in a Flow step can call to fetch live data from your own systems, such as your helpdesk or product catalogue. The AI decides when to call it, fills in any values it needs, and uses the response in its analysis.
Example: a customer sends photos of an item they received. One AI Skill reads the product ID from the ticket, an API tool fetches that product's official title, description and images from your catalogue, and a second AI Skill compares them with the customer's photos.
Where do I add one?
API tools are attached to a Flow step, alongside that step's AI Skills.
Open your Flow and go to the AI Skills tab.
Under the step you want, click Add → Tools.
Choose Create new to build a tool, or Browse existing to reuse one you already made.
The tool then appears under API TOOLS in that step, with its method and URL. Use the toggle to switch it on or off, and the bin icon to remove it from the step.
What do I fill in?
The tool editor has four tabs.
Tab | What you set | Tip |
General | Name and Description | The AI decides when to call the endpoint based on its description, so say plainly what it returns (for example, "Retrieve product image, description and title"). |
Parameters | Values the AI fills in when it calls the endpoint: a name, a type (for example number), a description, and whether it is Required | Mark a parameter as Required when the call cannot work without it. The AI must then provide it to call the endpoint. |
Request | Method, URL, query parameters and headers | Insert a parameter anywhere with |
Authentication | A saved Credential, the Header it goes in (for example | Secrets are masked and never shown again after saving. Use Replace secret to rotate one. |
General — name the tool and describe what it returns
Parameters — add each value the AI must provide.
Request — choose the method and enter the URL, query parameters and headers.
Authentication — pick or create a credential and set the header and scheme.
Which placeholders can I use?
Besides your own parameters, you can insert these values from the SnapCall session. Click View available placeholders in the editor to copy them.
Placeholder | Value |
| The stream's external ID, usually your helpdesk ticket ID |
| The token of the stream the session runs in |
| Your SnapCall company ID |
Example: https://yourcompany.zendesk.com/api/v2/tickets/{{ticket}} fetches the ticket the clip was sent from, with no parameter for the AI to fill in.
What's the difference between {{ticket}} and {{$.productId}}?
{{ticket}} and the other {{stream.…}} placeholders are filled in by SnapCall from the session. {{$.key}} values are parameters the AI fills in itself, from the media or from earlier results, each time it calls the tool.
How do I check that a tool works?
Click Test in the tool editor before saving. Then send a test clip through the Flow with the Test button at the top of the Flow and check the AI Skills results.
Can I reuse a tool in several Flows?
Yes. In any step, click Add → Tools → Browse existing and pick the tool.