Skip to main content
The API Flow node sends a chain of HTTP (XHR/fetch) requests as one atomic step. Use it instead of UI interactions when a site’s internal API returns the data you need, or performs the action you want, directly. It is faster and less brittle than clicking through the UI. By default the requests run in the browser’s live session, so the site’s cookies attach natively. You never read, store or pass cookies yourself. With credentials: "omit", the requests run cookie-free through a server-side relay instead, for endpoints that don’t need the user’s session.

Example

Search for a story, then fetch the top result. The second step reads a value extracted by the first:
After the node runs, {{context.top_story_title}} holds the title and it appears in the run result.

Parameters

Field map

field_json_map sees steps.<id>.* for every step and target, the target step’s result (the same object as steps.<target_step_id>). The workflow context is not in scope: context.* evaluates to nothing, without an error. Build context-derived fields in a Transform node after this one. When the node runs again in the same run, for example inside a loop, a top-level array replaces its previous value. An array nested in an object, including under runtime, is appended to the previous one, and a null value leaves the previous value in place. To start fresh on each run of the node, delete that path with a Transform node before it.

Steps

Value Flow

Steps run in array order. Later steps read earlier results with inline references: {{ steps.<step_id>.<extract_name> }} in url, query, headers, or a body value. List every step after the steps it references. Workflow variables such as {{ context.inputs.order_id }} work in the same fields.

Extract

Each entry has a name and one of three sources: Set required: true to fail the step when no value is found. Without it, a missing value silently becomes empty in later references. A response_text extraction returns one match; to collect many, use $match in field_json_map.

Body

A file source is { "type": "signed_url", "url" }, { "type": "workflow_input", "path" }, or { "type": "prior_step", "step_id", "extraction_name" }.

Pagination

repeat sends the step repeatedly and collects the pages:

Limits

Saving a workflow fails if an API Flow node breaks these limits:
  • At most 20 steps per node
  • Step IDs must be unique and match the ID format above, and target_step_id must name one of them
  • Extraction names must be unique within a step
  • At most 40 headers and 40 query parameters per step
  • retry.max_attempts at most 5
  • repeat.max_iterations is required and at most 100

Edges

API Flow uses a single to edge to the next node.

Notes

  • With the default credentials: "include", requests are sent from the page the browser is on. If that page has a different origin than the API (a different subdomain counts), the request fails. Make sure the Start URL or an earlier Navigate puts the browser on the right origin
  • POST, PUT, PATCH and DELETE steps change data on the target system on every run. Test them carefully
  • If an API Flow node replaces UI steps that did the same thing, remove those steps, or the action runs twice
  • The Builder Agent can build API Flow nodes from network traffic it captures while you navigate the site