Skip to main content
API Tools Docs The API tool lets your agent call external APIs during a conversation. Use it to fetch data from third-party services, submit information to webhooks, or integrate with any REST API. Unlike the Function tool, the API tool requires no JavaScript code, making it accessible to less-technical builders.

​
Creating an API tool

1

Create the tool

You can add, or create an API tool directly from within a playbook.API Playbook Docs
You can also create API tools from within a workflow using the API step, or from the tools CMS tab.
2

Configure the request

Define your HTTP request:
FieldDescription
MethodGET, POST, PUT, PATCH, or DELETE
URLThe endpoint to call. Use curly braces for variables (e.g. https://api.example.com/users/{user_id})
HeadersKey-value pairs like Authorization or Content-Type
ParametersQuery parameters appended to the URL
BodyRequest body for POST, PUT, and PATCH requests — choose from Form data, URL encoded, or Raw (e.g. JSON)
3

Add input variables

Optionally define input variables that can be passed in by a playbook or an API step. Use them in your URL, headers, or parameters by wrapping them in curly braces. Add a description to each so the agent knows what to pass.
4

Test the request

Click Run in the top right corner to test your API call. Click Variables to enter test values, then Run to execute. The response panel shows the JSON body, status code, size, and response time (e.g. 200 OK · 11.3 kB · 354ms). Use Show raw for the unformatted response, or the Headers tab to inspect response headers.

​
Testing the API tool

Click Run in the top right corner of the API tool editor to test your API call. Click Variables to enter test values for your input variables, then click Run to execute the request. The response panel displays the JSON response body along with the status code, response size, and response time (eg: 200 OK · 11.3 kB · 354ms). Click Show raw to see the unformatted response, or use the Headers tab to inspect the response headers.

​
Using the API tool

There are two ways to use an API tool:

​
In a playbook

Add the API tool to a playbook’s Tools editor. The agent will call it autonomously when it determines the tool is needed based on the conversation context and your playbook instructions. For example, an “Order Lookup” API tool added to an order status playbook — the agent decides when to call it, passes the right input variables, and uses the response to answer the customer. API Playbook Docs Give the tool a clear name and description so the agent knows what it does. If you need to guide when the agent uses it, add that guidance to your playbook instructions.

​
In a workflow

Drag an API step onto the canvas and select the API tool you want to call. Input variables are mapped explicitly in the step config — the agent doesn’t decide whether to call it, the workflow executes it at that point in the flow every time. Use this when the API call is part of a fixed process — for example, always verifying identity before accessing account data, or always sending a confirmation after a booking is made. API Step Docs 1