> For the complete documentation index, see [llms.txt](https://documentation.proto.cx/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.proto.cx/docs/modules/ai-agents/workflows-and-actions/send-api-request.md).

# Send API Request

The Send API Request action supercharges your AI agent, allowing it to send custom requests to external systems and receive responses. This is useful for utilities like automations, external actions, database updates, and external reporting.

***

Select a **Send API Request** action from the tree to open its settings:

* **HTTP method** — the request type: 
  * **GET** — retrieves information about the REST API resource.
  * **POST** — creates a REST API resource.
  * **PUT** — updates a REST API resource.
  * **DELETE** — deletes a REST API resource or related component.
  * **PATCH** — makes a partial update to a REST API resource.
* **URL endpoint** — the endpoint to receive requests, which must start with `https://`. 
* **Headers** — optional **Key** / **Value** pairs of content for the request header.
* **Resulting variable** — the name of the new or existing [chat variable](/docs/developers/chat-variables.md) whose value will be set in the chat by a GET response.

Press **Save** to confirm edits.

To test an API request, use a [Webchat](/docs/modules/ai-agents/publishing/webchat.md) preview to interact with the AI agent and trigger the request.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.proto.cx/docs/modules/ai-agents/workflows-and-actions/send-api-request.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.