Quick links
Workflow builder overview
Where you build workflows on the visual canvas.
Node types overview
The nine node types and what each one does.
Common questions
How do I build and run a workflow?
How do I build and run a workflow?
Open the Workflow Builder, add nodes to the canvas, connect them in the order you want them to run, then save and deploy. Click Run to execute it in the app, or trigger it from the API. See running workflows for the in-app run view and run via API to trigger one from code.
What node types are there?
What node types are there?
There are nine node types: LLM, Tool, Function, Agent, Conditional, Interrupt, Transformer, Guardrails, and Knowledge. Each one does a different kind of work in a run. The node types overview explains what each does and when to use it.
How do I pass data between nodes?
How do I pass data between nodes?
Reference an earlier node’s output with the
{{node_id.field}} syntax — for example, {{search.results}} pulls the results value from the node with the id search. Every node writes its result into the run under its own id, so any later node can read it. See variables & references.Can I pause a workflow to ask the user something?
Can I pause a workflow to ask the user something?
Yes. Add an Interrupt node where you want the run to wait. When the run reaches it, the run pauses, asks your question, and waits for an answer before continuing. See the Interrupt node.
How do I stop a running workflow?
How do I stop a running workflow?
Cancel it from the run view in the app, or call the cancel endpoint from code. Cancellation is graceful: the run stops after the current node finishes, not mid-step. Only runs that are still running or paused can be cancelled. See running workflows.
How do I watch a run live?
How do I watch a run live?
Stream it. In the app, the run view shows each step as it happens. From code, open the run’s event stream — in the SDKs this is the
listen() method, which yields events as they occur until the run finishes. See running workflows.Run a workflow from code
When you trigger a run, ModuleX returns immediately with the run details, then you open a separate stream to watch progress. Authenticate every request withAuthorization: Bearer mx_live_… and the X-Organization-ID header. In the SDKs, pass your API key and organization id when you create the client.
Running a workflow on ModuleX-managed models and tools consumes credits, and the run is blocked if your organization is out of credits. See usage gating & limits and errors & troubleshooting.
Related help
AI Composer & Assistant — help
Generate a workflow from a plain-English prompt, or let the Assistant work step by step.
Errors & troubleshooting — help
What common errors mean and how to fix a failed run.