run_flow

run_flow

Run a saved flow.

MCP tool	run_flow
HTTP	POST /flows/{name}/runs

Every step, in order, server-side, against this session's browser. Stops at the first failing step unless that step says onError: continue, and reports which step stopped it and what page the browser was on. Returns a line per step; pass verbose for every step's full result.

Parameters

Name	Type	Required	Default	Notes
name	string	yes	—
params	object	no	—	The values this flow declares.
verbose	boolean	no	false

Every call names its session: an X-Session-Key header, or ?session=<name>. Sending both is refused. See Sessions.

Returns

Field	Type	Notes
flow	string
session	string
status	string
hint	object	On a failed run: where to read about this kind of failure and which prompt repairs it. read is absent when the skill is not being served.
steps_run	integer
steps_total	integer
steps	array
url	string
title	string

Errors

Status	Means
400	The request cannot succeed as sent — an unusable name, a flow that does not exist, a document that would not run, or a write aimed at the read-only shared library. Do not retry it unchanged.
401	Missing or wrong bearer token.
500	Something failed that this server did not expect.

Over MCP the same failures arrive as a tool error.

Example

MCP

run_flow(name="…")

HTTP

curl -X POST $SELENIUM_FLOW/flows/my-flow/runs \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-Session-Key: $SESSION"

---

← All actions · Installing · Deployment