run_flow

run_flow

Run a saved flow.

MCP tool	run_flow
HTTP	POST /flows/run

Every step, in order, server-side, against the browser named by session_id. 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
session	string	no	—	Whose library. Defaults to the caller's session name if the request carries one, else the shared 'global' library.
name	string	yes	—
session_id	string	yes over HTTP	—	The browser to run in. Required: this surface is always explicit, so open one with /browser/open first.
params	object	no	—	The values this flow declares.
verbose	boolean	no	false

Returns

Field	Type	Notes
flow	string
session	string
status	string
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/run \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "session_id": "…",
    "name": "…"
  }'

---

← All actions · Installing · Deployment