Skip to main content
The API node executes HTTP requests to external APIs and web services. It provides flexible configuration for making GET, POST, PUT, DELETE, and other HTTP requests with custom headers, bodies, and authentication.

HTTP Methods

Support for all standard HTTP methods (GET, POST, PUT, DELETE, etc.)

Custom Headers

Configure custom headers for authentication and content types

Request Body

Send JSON, form data, or raw content in request bodies

Response Processing

Automatically parse and process API responses

Configuration Options

Basic Settings

Set a descriptive name for your API node. This helps identify the node’s purpose in your workflow.
Provide a clear description of what this API request will accomplish.

Request Configuration

Method: Select the HTTP method from the dropdown (GET, POST, PUT, DELETE, PATCH, etc.)URL: Enter the full URL endpoint for your API request. You can use variables in the URL path.
Configure custom headers for your request:
  • Content-Type: Set to application/json for JSON data
  • Authorization: Add Bearer tokens or API keys
  • User-Agent: Custom user agent strings
  • Accept: Specify expected response format
The request body for POST, PUT, and PATCH requests:
  • JSON: Send structured data as JSON
  • Form Data: Send form-encoded data
  • Raw: Send plain text or custom formatted data
Example JSON body:
{
  "name": "John Doe",
  "email": "[email protected]",
}

Response Handling

Success Responses

Status Codes: 200-299 range considered successful
  • Response data automatically parsed
  • JSON responses converted to objects
  • Text responses passed as strings
  • Response available for next nodes

Error Handling

Error Conditions:
  • Network timeouts and connection errors
  • HTTP error status codes (400-599)
  • Invalid JSON responses
  • Custom error handling based on response content

Common Examples

GET Request - Fetch Product Details

Method: GET
URL: https://api.store.com/products/12345
Headers: 
  Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
  Content-Type: application/json

POST Request - Create New Product

Method: POST
URL: https://api.store.com/products
Headers:
  Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
  Content-Type: application/json
Body:
{
  "name": "Wireless Headphones",
  "price": 99.99,
  "category": "electronics",
  "in_stock": true
}
Test your API endpoints independently before integrating them into your workflow to ensure proper authentication and data formatting.
I