What and how it can be used:
The API Request component makes HTTP requests to external APIs and services, enabling workflows to interact with third-party systems. It sends HTTP requests (GET, POST, PUT, DELETE, PATCH) with configurable headers, body, query parameters, and authentication, then receives and processes API responses. This component bridges Arkus workflows with external REST APIs, webhooks, and web services for data exchange and integration.
When/how the component should be used:
- Use for calling external APIs and web services
- Use when you need HTTP communication
- Use for data synchronization
- Configure HTTP method (GET/POST/etc.) and endpoint.
- Pass parameters or payload from Text Input, Parser, or Prompt Template.
- Surface response and errors directly to downstream components.
- Optionally parse or structure the response using Parser or Structured Output.
Connections with other components:
- ChatOutput
- Data Operations
- Parser
- Save File
- Smart Function
- Split Text
- Type Convert
- Notify
- ChromaDB
In tool mode:
- Agent Core
- Human-in-the-loop
Configurable settings:
- Mode (Choose the mode)
Mode = URL
- URL (Write the url)
- Method ( Choose the method)
Mode = cURL
- cURL (Write the url)
Default settings:
- Mode (Choose the mode)
Mode = URL
- URL (Write the url)
- Method ( Choose the method)
Mode = cURL
- cURL (Write the url)
Control Section:
Mode = URL
- Mode
- URL
- cURL
- Method
- Query Parameters
- Body
- Headers
- Timeout
- Follow Redirects
- Save to File
- Include HTTPx Metadata
- Actions in Tool mode
Mode = cURL
- Mode
- URL
- cURL
- Method
- Query Parameters
- Body
- Headers
- Timeout
- Follow Redirects
- Save to File
- Include HTTPx Metadata
- Actions in Tool mode
Default values:
Mode = URL
- Method = GET
- Mode = URL
- Timeout = 30
- Follow Redirects = on
- Actions = MAKE_API_REQUEST
Mode = cURL
- Method = GET
- Mode = cURL
- Timeout = 30
- Follow Redirects = on
- Actions = MAKE_API_REQUEST
Desired Behaviour:
- Send request and return response clearly
- Show errors instead of hiding them.