Node reference
API node: call your own APIs with saved auth
api_request · Updated September 19, 2026
The API node calls one of the APIs you registered on the APIs page, using its stored auth: a bearer token, an API key, OAuth 2.0, AWS Signature v4 or any other supported scheme. The secret stays on the server.
When to use it
- Calling an internal or third-party API that is not in the Connectors catalog.
- Giving an agent a tool built from a saved endpoint, with its inputs described for the model.
Ports
- Inputs
in- Outputs
outerror- Tool
attachable to an agent's tools port
Configuration
- API
api_idrequired - string
- Endpoint
endpointrequired - string
- Inputs
args - objectValues may use templates. As a tool, the agent fills whatever is left empty.
- Method
method - GET | POST | PUT | PATCH | DELETE | HEAD | OPTIONS · default "GET"
- Path
path - templateRelative to the API's base URL, e.g. /v1/items.
- Query parameters
query - object
- Headers
headers - object
- JSON body
body - object
- Tool description
tool_description - stringShown to the agent when this node is attached as a tool. Defaults to the endpoint's description.
- Tool arguments (JSON Schema)
tool_args_schema - objectReference the model's arguments with {{ args.<field> }}.
Output
Fires out with status, headers and the parsed body for a 2xx response. Any other status fails the node, which fires error under the error_port error mode.
Example
Endpoint: Get invoice (GET /invoices/{invoice_id})
invoice_id: {{ trigger.invoice_id }}Good to know
- Inputs you fill in are fixed; as a tool, the agent only chooses the ones left empty.
- See Custom APIs for the supported auth schemes and saving endpoints.
Keep reading
- Custom APIs: connect any HTTP API with any authRegister any HTTP API once with its base URL and auth, from no auth and API keys to OAuth 2.0 and AWS Signature v4, then call it from workflows and agents.
- Agent node: Claude with tools and structured outputThe Agent node calls Claude with your prompt, can call attached HTTP tools in a loop, and returns text plus schema-validated structured output for branching.
- HTTP Request node: call any API, or give an agent a toolThe HTTP Request node calls any API as a workflow step, or attaches to a Claude agent as a tool it can call with its own arguments.
Build it on the canvas
Create a free account, describe the workflow or wire it yourself, and run it in the browser.