Skip to main content
The HTTP API step makes a single HTTP request and captures the response in the workflow context. It’s the go-to step for talking to external systems that don’t have a dedicated Action integration.
HTTP API step inspector

​
When to use it

Use HTTP API whenUse Action instead
The API is custom or internalThe integration exists in Pipedream
Bearer-token auth is sufficientYou want OAuth managed automatically
You need full control over the raw requestThe app has complex configuration handled better via Action

​
Inspector fields

FieldDescription
MethodGET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
URLFull URL — supports expressions like {{ ctx.input.contact_id }}
Add headersKey-value pairs for request headers
Add query parametersKey-value pairs appended to the URL
For POST, PUT, and PATCH requests, a body editor appears for the request payload.

​
What lands in ctx

After the step runs, it adds to ctx under the step’s name: 
{
  "n4": {
    "status_code": 200,
    "headers": { "content-type": "application/json" },
    "body": { "id": "c_123", "first_name": "Alice", "tier": "gold" }
  }
}
Reference downstream: 
{{ n4.status_code }}
{{ n4.body.first_name }}

​
Examples

​
Authenticated GET with query params

URL: https://api.example.com/contacts Headers: 
Authorization: Bearer {{ ctx.input.crm_token }}
Accept: application/json
Query parameters: 
email: {{ ctx.input.customer_email }}

​
POST with a dynamic JSON body

Method: POST URL: https://api.example.com/tickets Body: 
{
  "subject": "Call with {{ n3.contact_name }}",
  "duration": "{{ n3.duration }}",
  "status": "open"
}

​
AI-generated request body

{
  "subject": "${ write a one-line ticket subject for this call: {{ n4.transcript }} }",
  "summary": "${ summarize this call in 3 sentences: {{ n4.transcript }} }",
  "priority": "${ pick a priority (low|normal|high) for this call: {{ n4.transcript }} }"
}

​
Limits

LimitValue
Request timeout30 seconds
Max response size10 MB
Blocked addressesPrivate IPs, loopback, multicast, link-local