Skip to main content

​
1. Add the steps

Open Workflows in the sidebar and create a workflow. Tell the Brain (the chat beside the canvas) what you want, for example “run my competitor-prices skill, keep prices under my price, and post them to Slack”. It adds the steps, writes code steps, and wires outputs into later steps. You can also add and set up steps yourself from the canvas toolbar. See Workflows for the step types. From code, you can create and change workflows with POST /v1/workflows and PATCH /v1/workflows/{slug}.

​
2. Declare the inputs

Click the API trigger, the first node on the canvas. Add one entry per input: You cannot delete the trigger. A workflow made before triggers existed gets one automatically, with one required string input for each {{inputs.name}} its steps already use.

​
3. Use the inputs in steps

Write {{inputs.<name>}} in any step setting: a skill step’s inputs, its Max results, an HTTP URL or body, a condition. Code steps also get every input in the inputs dictionary.

​
4. Run it

The slug is on the workflow’s API tab. Read the contract (inputs, output shape, track record) with GET /v1/workflows/{slug}.
If it finishes within wait seconds (default 60, max 120), you get 200 with outputs. If not, you get 202 with a run_id: read it with GET /v1/runs/{run_id}. Inputs are checked first. A missing input, a wrong type, or an unknown name returns 422 with every problem listed, and nothing runs. Values are converted when they can be: "3" becomes 3 for an integer input.

​
Who can run it and who pays

  • The owner and members of its workspace can read and run it. Anyone else gets 404.
  • An API key limited to some workflows gets 403 on any other. See API keys.
  • The owner pays. See Workflows: cost. API and assistant runs do not use your monthly run allowance.