Skip to main content
The API Call node sends an HTTP request to an external API and stores the response for use in downstream nodes.

​
Behavior

  • Sends an HTTP request with the configured method, headers, body, and authentication
  • Retries on failure up to the configured retry count
  • Stores response body, status code, and headers as output variables
  • Routes to Success, Error, or Timeout based on the outcome

​
Configuration

​
Request

ParameterTypeDefaultOptionsDescription
urlstring""—API endpoint URL. Supports {{variable}} interpolation.
methodenum"GET"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONSHTTP method
requestBodystring""—JSON body template. Supports {{variable}} interpolation.
headersobject{}—Request headers as key-value pairs

​
Authentication

ParameterTypeDefaultOptionsDescription
authTypeenumnullbearer, basic, x-api-keyAuthentication type
authCredentialsstring""—Auth token, credentials, or API key
usernamestringnull—Username for basic auth
passwordstringnull—Password for basic auth

​
Reliability

ParameterTypeDefaultRangeDescription
timeoutnumber100001,000–60,000Request timeout in milliseconds
retriesnumber20–5Number of retry attempts on failure

​
Output handles

HandleDescription
SuccessRequest returned a successful response (2xx)
ErrorRequest failed (non-2xx status, network error)
TimeoutRequest exceeded the configured timeout

​
Output variables

VariableTypeDescription
bodyanyResponse body (parsed JSON or raw text)
status_codenumberHTTP response status code
headersobjectResponse headers as key-value pairs

​
Example

Look up a customer by phone number: 
{
  "url": "https://api.example.com/customers?phone={{caller_phone}}",
  "method": "GET",
  "headers": {
    "Content-Type": "application/json"
  },
  "authType": "bearer",
  "authCredentials": "{{api_token}}",
  "timeout": 5000,
  "retries": 1
}

​
Use cases

Look up the caller’s account in your CRM by phone number. On success, use the response data to personalize the greeting.
POST to a scheduling API with the caller’s selected date/time (collected via Collect Digits or Speech Input).
POST call data to a webhook endpoint for real-time event processing. Use {{variable}} interpolation in the request body.