print - kubed-io/selenium-flow GitHub Wiki

print

Print the page into the workspace's files, kept past the browser.

MCP tool print
HTTP POST /browser/print

format="pdf" is the browser's own print: selectable text, the whole document. landscape turns the page and background keeps colours and images a print drops. format="html" is the page as it stands now, after its scripts ran.

To give it to a person, give them the file's url: it opens in any browser without a token. A server with no public address configured returns it relative instead.

Parameters

Name Type Required Default
url string no โ€”
format string no pdf
filename string no โ€”
landscape boolean no false
background boolean no false

Every call names its workspace: an X-Workspace header, or ?workspace=<name>. Sending both is refused. See Workspaces.

Returns

Field Type Notes
file FileEntry
format string
bytes integer Size of the file in bytes.
url string Current URL after the action.
title string Page title after the action.
site_data object Present only when site data was restored, skipped or forgotten in this call.
page object Present only when this browser was opened with capture=true and the page reported a failure while the call ran: what it caused, and where to read it.

Errors

Status Means
400 The request cannot succeed as sent โ€” a missing field, a value that was rejected, or a locator that matched nothing before the wait ran out. Do not retry it unchanged.
401 Missing or wrong bearer token.
404 No such browser session. It ended, the Grid reaped it, or the id was never real. Open a new one and retry.
413 The body is over its cap: 1 MiB of JSON, 64 MiB of upload, 1 MiB of flow YAML. Send less; retrying it unchanged will fail again.
500 Something failed that this server did not expect.
503 The Grid could not serve this โ€” unreachable, or no free slot for a new browser. Worth retrying after a wait.

Over MCP the same failures arrive as a tool error.

Example

MCP

print()

HTTP

curl -X POST $SELENIUM_FLOW/browser/print \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-Workspace: $WORKSPACE"

โ† All actions ยท Installing ยท Deployment

โš ๏ธ **GitHub.com Fallback** โš ๏ธ