Skip to main content
PATCH
Update a page

Authorizations

Authorization
string
header
required

Your Reason API key from Settings › API keys. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, devices:read, devices:write, devices:use, computers:read, computers:write, ssh:write, knowledge:read, memory:read, memory:write, skills:read, skills:write, pages:read, pages:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. devices:write, devices:use, computers:read, computers:write, ssh:write, network:read and network:write are opt-in, excluded from default keys. computers:read lists visible cloud and connected computers without waking them or granting execution access. devices:read discovers local Device targets; devices:use separately consents to local execution, so a discover-and-run local workflow needs both. devices:write manages enrollment and device grants; computers:write creates or deletes cloud computers; ssh:write manages retained SSH access. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

pageId
string<uuid>
required

The page id, returned as id by listPages and createPage, or the page= parameter of a page link.

Body

application/json

At least one of html or title.

html
string

The whole new page. Omit it to keep the current HTML and only rename.

title
string

A new name. Omit it to keep the page's current name.

height
integer

The frame height in CSS pixels; omit it to fit the page.

Response

The page at its new revision (the same revision when nothing changed).

id
string

The page's id, from listPages, createPage or a page link's page= parameter.

title
string

The page's name.

revision
integer

1 when made, one more for each update under the same id.

kind
enum<string>

page for an HTML page; document for a Markdown document page, which this API reads but does not write.

Available options:
page,
document
session_id
string

The Session the page lives in.

url
string

The page's link in Reason: its Session opened on the page, for anyone who may read that Session. It never changes.

view_url
string | null

A short-lived URL that serves the page itself for the caller (sandboxed HTML); null for a document.

view_url_expires_at
string<date-time> | null

When view_url stops loading.

preview
object | null

The hero picture of the current revision; null until one is captured (the Library then renders the page live).

preview_capture
enum<string>

On create and update: scheduled when the page's Session has a running turn of yours whose machine takes the hero picture now; not_running when it has none, so the Library renders the page live until a later turn shows it.

Available options:
scheduled,
not_running
share
object
source
string

With include=source: the page's HTML as written (local images inlined), or a document's Markdown.