For the complete documentation index, see llms.txt. This page is also available as Markdown.

Send API request

Leverage third-party utilities in a chat.

Action — Sends a request to an external endpoint and receives the response. Supports GET, POST, PUT, DELETE, and PATCH.

What it does

Calls an external API mid-chat and stores the response in a variable for use by downstream actions. Useful for automations, external actions, database updates, and external reporting.

When to use it

To bring live external data into a chat — looking up a complaint status, fetching account details, or pushing data out to another system.

Settings

Setting
Description

HTTP method

The request type: GET (retrieve), POST (create), PUT (update), DELETE (delete), PATCH (partial update).

URL endpoint

The endpoint to receive requests. Must start with https://.

Headers

Key / Value pairs for the request header. Optional.

Resulting variable

The chat variable whose value will be set from the response.

Press Save to confirm edits.

To test an API request, use a Webchat preview to interact with the AI agent and trigger the request.

Send APISet variable

Last updated