> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gidr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API

> Connect your AI agent to external services and APIs.

<img src="https://mintcdn.com/gidrai/La57oM6sCecLAz60/images/ai-studio/rest-api-clean-workflow.png?fit=max&auto=format&n=La57oM6sCecLAz60&q=85&s=bb0d39eef7917f77b186c570c5ff7f7e" alt="REST API Node Workflow" width="1385" height="922" data-path="images/ai-studio/rest-api-clean-workflow.png" />

## Overview

The **REST API** node enables your workflow to interact with external systems using standard HTTP requests. This is essential for fetching data from third-party services, triggering external actions, or integrating with your own backend APIs.

## Configuration

<img src="https://mintcdn.com/gidrai/La57oM6sCecLAz60/images/ai-studio/rest-api-config-top.png?fit=max&auto=format&n=La57oM6sCecLAz60&q=85&s=c709fb666a1df70bf7670553b9db0a0b" alt="Configuration Top" style={{ width: '300px' }} width="322" height="428" data-path="images/ai-studio/rest-api-config-top.png" />

<img src="https://mintcdn.com/gidrai/La57oM6sCecLAz60/images/ai-studio/rest-api-config-middle.png?fit=max&auto=format&n=La57oM6sCecLAz60&q=85&s=7553101f59c5bba930c15bf8a8229e1f" alt="Configuration Middle" style={{ width: '300px' }} width="322" height="428" data-path="images/ai-studio/rest-api-config-middle.png" />

<img src="https://mintcdn.com/gidrai/La57oM6sCecLAz60/images/ai-studio/rest-api-config-middle-post.png?fit=max&auto=format&n=La57oM6sCecLAz60&q=85&s=ec356cdcb7d78afec6d1badb679eb910" alt="Configuration Middle" style={{ width: '300px' }} width="322" height="139" data-path="images/ai-studio/rest-api-config-middle-post.png" />

<img src="https://mintcdn.com/gidrai/La57oM6sCecLAz60/images/ai-studio/rest-api-config-bottom.png?fit=max&auto=format&n=La57oM6sCecLAz60&q=85&s=dddb002bf53e8e4f4798b1d00fbc85d0" alt="Configuration Bottom" style={{ width: '300px' }} width="322" height="428" data-path="images/ai-studio/rest-api-config-bottom.png" />

### Request Details

* **Request type**: Select the HTTP method (GET, POST, PUT, DELETE, PATCH).
* **Request URL**: The endpoint URL. Supports dynamic variables from previous steps (e.g., `https://api.example.com/users/{{userId}}`).

### Parameters & Headers

* **Headers**: Add custom headers like `Authorization` or `Content-Type`.
* **Query params**: key-value pairs appended to the URL (e.g., `?limit=10`).
* **Path params**: Variables to replace placeholers in your URL path.

### Request Body (POST/PUT/PATCH)

* **Body**: The payload to send with the request. This can be raw JSON or text. You can inject workflow variables into the body using `{{variable_name}}` syntax.

### Advanced Settings

* **Timeout**: Maximum time in seconds to wait for a response.
* **Retries**: Number of times to retry the request if it fails.

### Outputs

* **Output variables**: Define variables to map fields from the JSON response to workflow variables for use in subsequent nodes.
