HTTP endpoints

HTTP: ui

All 3 ui endpoints, with request fields and access notes.

On this page

GET /v1/ui/commands
POST /v1/ui/commands
POST /v1/ui/commands/{seq}/result

Request fields and access notes below are partial. Additional constraints and permissions may apply. Prefer the corresponding MCP tool and schema where available.

GET /v1/ui/commands

Read ui commands poll.

Query field names (types and requiredness not specified here): after_seq, timeout.

POST /v1/ui/commands

Ui command post.

Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply.

Request body fields (partial)

Field	Type	Required	Constraints
`verb`	string	yes	See operation notes.
`room_id`	string	no	See operation notes.
`artifact_id`	string	no	See operation notes.
`message_id`	integer	no	See operation notes.
`tab`	string	no	See operation notes.
`open`	boolean	no	See operation notes.
`url`	string	no	See operation notes.
`path`	string	no	See operation notes.
`label`	string	no	See operation notes.
`by_agent_id`	string	no	See operation notes.
`project_id`	string	no	See operation notes.
`all`	boolean	no	See operation notes.
`action`	string	no	See operation notes.
`ref`	string	no	See operation notes.
`text`	string	no	See operation notes.
`key`	string	no	See operation notes.
`dx`	integer	no	See operation notes.
`dy`	integer	no	See operation notes.
`seconds`	string	no	See operation notes.
`max_chars`	integer	no	See operation notes.
`scale`	integer	no	See operation notes.
`alt`	string	no	See operation notes.
`description`	string	no	See operation notes.
`front`	boolean	no	See operation notes.
`title`	string	no	See operation notes.
`theme`	string	no	See operation notes.
`width`	integer	no	See operation notes.
`height`	integer	no	See operation notes.
`settle_ms`	integer	no	See operation notes.
`motion`	string	no	See operation notes.
`locale`	string	no	See operation notes.
`zoom`	string	no	See operation notes.
`restore`	boolean	no	See operation notes.
`presentation`	boolean	no	See operation notes.
`save`	string	no	See operation notes.
`save_to`	string	no	See operation notes.

Other constraints may apply, including for fields marked optional.

POST /v1/ui/commands/{seq}/result

Ui command result.

Path parameters: seq.

Access: LAN writes require an active session token. Local loopback requests are exempt from this requirement by default; other permissions still apply. Available only to loopback callers.

This directory does not provide a request schema for this endpoint. Use the corresponding supported tool or client where available.