REST API
Call external HTTP services from your flow. Optionally expose the call as a Tool the Model can invoke.
When to use
- Fetch or send data to your backend/3rd-party APIs.
- Let the LLM call an HTTP endpoint via function-calling (turn on Is Tool).
- Convert model output into structured requests and display results to users.
What it does
- Builds an HTTP request (method, URL, headers, params/query/body).
- Sends the request with a timeout.
- Returns JSON on
output(parsed if response is JSON; otherwise raw text).
Fields
| Field | Description | Example |
|---|---|---|
| Node ID * | Unique identifier for this node. | RestAPINode_5 |
| Is Tool | Defines whether this node should be callable as a tool by the LLM. Usually set to True. |
True |
| Base URL * | The root URL of the API endpoint. | https://api.openweathermap.org/data/2.5/weather |
| Tool Description * | A short explanation of what this tool or API call does. | Fetch current weather data for a given city. |
| Timeout | Sets the maximum time (in seconds) to wait for a response before timing out. | 10 |
| API Request Methods Method * | Defines which HTTP method to use. Supported options: GET, POST, PUT, PATCH, DELETE. |
get |
| Headers | JSON object containing custom headers for the request (e.g., authorization, content-type). | json\n{\n "Content-Type": "application/json",\n "Authorization": "Bearer {{api_key}}"\n} |
| Params | JSON object for URL parameters. Used mostly for GET requests. |
json\n{\n "city": "{{user_city}}",\n "units": "metric"\n} |
| Query | Optional query configuration for advanced GET/POST requests. | json\n{\n "lang": "en",\n "limit": 5\n} |
| Body | JSON body content for POST, PUT, or PATCH requests. | json\n{\n "message": "{{user_message}}"\n} |
| Arguments | (Optional) Predefined variables or inputs the API uses, usually set to None unless customized. |
None |