Quickstart: Connect your first API tool

Goal: Assistant fetches live data from your API (e.g. order status).

Prerequisites

• Starter plan or above (API Request tools)
• An HTTP API you can call with API key or Bearer token
• Assistant already created

Step 1 — Add credential

1. Go to Credentials → Create.
2. Choose auth type (Bearer token or API key).
3. Paste your secret — it is stored encrypted and never shown in chat.

Step 2 — Create tool

1. Go to Tools → Create → API Request.
2. Name: get_order_status (snake_case — used by AI).
3. Description: Look up shipping status for a customer order. Use when the visitor provides an order number.
4. URL: https://api.yourstore.com/orders/{order_id}
5. Method: GET
6. Path parameter: order_id (string, required)
7. Attach credential.
8. Save and Test with a sample order ID.

Step 3 — Attach to assistant

1. Open assistant → Tools.
2. Enable tools and select get_order_status.
3. Save.

Step 4 — Test in chat

Ask: “Where is order #12345?” — assistant should call the tool and return live data.

Next

• Path and query parameters
• Rich content carousels