Create an API Request tool
An API Request tool defines a single HTTP call your assistant can make — URL, method, parameters, optional JSON body, and an attached credential.
Prerequisites
Section titled “Prerequisites”- Starter plan or above (API Request tools)
- A reachable HTTP API and auth details
- Optional: credential already created
- Go to Tools → Create → API Request.
- Fill in Name (snake_case, e.g.
get_order_status) — the model uses this identifier when calling the tool. - Write a clear Description — when to use the tool, required visitor inputs, and what it returns.
- Set URL and method — e.g.
GET https://api.example.com/orders/{order_id}. - Define parameters:
- Path params
- Query params
- Headers (static or dynamic)
- JSON body schema for POST/PUT/PATCH
- Attach a credential.
- Optional: configure execution mode, strict params, status notifications, and result_transform for rich cards.
- Save, then Test with sample values.
Naming tips
Section titled “Naming tips”| Field | Guidance |
|---|---|
| Name | snake_case, verb-led: search_products, create_booking |
| Description | Include trigger phrases, required params, and success/failure behavior |
Example
Section titled “Example”| Setting | Value |
|---|---|
| Name | get_order_status |
| Description | Look up shipping status when the visitor provides an order number. |
| URL | https://api.yourstore.com/orders/{order_id} |
| Method | GET |
| Path param | order_id (string, required) |
| Credential | Bearer token for your store API |
Next steps
Section titled “Next steps”- Attach the tool to your assistant
- Test in the assistant preview
- Review execution logs after live traffic