> ## Documentation Index
> Fetch the complete documentation index at: https://ara-90a60a07.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Update a page
> Replaces a page's HTML and/or renames it as a new revision under the same id: its link, share link and Library row stay, so one page stays one page. Works on any page you may see, from any Session, as the agent's app_show with page_id does; send the whole new page (getPage with include=source gives back the current one). Checked as createPage checks a page. Requires pages:write and a member who may write.
Scope: `pages:write`
## OpenAPI
````yaml /openapi.json patch /v3/organizations/{orgId}/pages/{pageId}
openapi: 3.1.0
info:
title: Reason API
version: 3.0.0
description: >-
The Reason HTTP API. Drive cloud software-engineering agents: open sessions
against your repositories, stream their work, and manage the secrets,
skills, and automations they run with.
Authenticate with a Reason API key sent as a bearer token. New keys use
`reason_`; legacy `ara_` keys remain accepted. Every resource is scoped to
an organization; resolve your `org_id` once with `GET /v3/self`.
servers:
- url: https://api.reasonmachines.com
security:
- reasonApiKey: []
tags:
- name: Account
description: Verify a key and resolve the organization it belongs to.
- name: Reasons
description: >-
Start here. A Reason is the long-running agent a person keeps: their main
Reason and named ones, each with its own instructions, default model and
repositories, conversation, Loops and Sessions. Give a Reason work by
messaging it (sendReasonMessage) and read its replies with
listReasonMessages.
- name: Loops
description: >-
Standing work a Reason does, woken by a schedule or an event: a webhook, a
GitHub event or a Slack message. Each wake opens or continues a Session of
the Reason; webhook events that share a correlation key continue one
Session.
- name: Memory
description: >-
What Reasons remember across Sessions. Each Session starts by reading
MEMORY.md (a short index) and the list of topic notes, and reads a note
when its topic comes up. `personal` memory belongs to one person (the API
key's owner) and only their Sessions read it; `team` memory belongs to the
Workspace and every member's Sessions read it. memory:read lists, reads
and searches; memory:write writes and deletes, in team memory only for a
Workspace owner or admin.
- name: Sessions
description: >-
A Session is one run of work inside a Reason: every Reason message and
Loop wake runs in one, and createSession starts one directly for a single
unattended task with a pass/fail outcome. Its transcript, events, result
and pull request are read here.
- name: Skills
description: >-
Reusable instruction bundles Reason selects semantically from their
descriptions for matching agent tasks.
- name: Pages
description: >-
The HTML pages Reasons make: charts, dashboards and reports a person reads
in the chat, opens full size, shares and finds in a Reason's Library. List
and read the pages you may see, make one in a Reason's conversation or a
Session, keep it current with updatePage (same id, link and share link, a
new revision), share it and delete it. pages:read reads; pages:write
writes. An Experiments feature (pages_api): elsewhere these return 403
`pages_api_unavailable`.
- name: Secrets
description: >-
Encrypted credentials injected into the agent's sandbox. Write-only:
values can be set but never read back.
- name: Attachments
description: >-
Files uploaded to the organization and shared with sessions, downloaded
via short-lived signed URLs.
- name: Repositories
description: Connected repositories, their indexing state, and generated wikis.
- name: Git Connections
description: Linked source-control accounts and the repositories they expose.
- name: Machines
description: >-
Named Workspace queues served by headless workers. Sessions target a
Machine by name and wait for a free worker; more workers serve more
Sessions concurrently.
- name: Devices
description: >-
Owned Mac and headless Device identity, bounded enrollment and root
grants.
- name: Cloud Access
description: >-
Keyless cloud sign-in for sessions: Reason's OIDC issuer facts and the
AWS, Google Cloud and Azure connections a workspace trusts, including
which run triggers each one signs in.
- name: MCP Servers
description: >-
Org-level Model Context Protocol servers exposed to the agent. Secret
values are write-only.
- name: Change Request Reviews
description: >-
Automated senior-engineer reviews posted on pull requests and merge
requests.
- name: Consumption
description: 'Billing-aligned usage: daily consumption and billing cycles.'
- name: Metrics
description: Aggregate analytics over sessions, change requests, and usage.
- name: Audit Logs
description: An append-only record of changes made within the organization.
- name: Organizations
description: The top-level tenant. Create, read, update, and delete organizations.
- name: Members
description: People in an organization and their pending invites.
- name: Roles
description: Role assignments that govern what each member can do.
- name: Settings
description: 'Organization configuration: namespaced settings and the run tag policy.'
- name: Provider credentials
description: >-
Configure Bring-Your-Own-Key (BYOK) API keys and subscription credentials
for model providers. Secret values are write-only.
- name: Feedback
description: Report problems with the API or these docs to the Reason team.
- name: Projects
description: >-
Deprecated: a project is a Reason with the same id. Use the Reasons
operations; these remain for existing clients.
- name: Automations
description: >-
The older form of Loops. Prefer the Loops under a Reason (listReasonLoops,
createReasonLoop), which take every wake: schedule, webhook, GitHub,
Slack. Use these for what Loops do not carry yet: a run's MCP and app
tools, and automations not filed under a Reason.
paths:
/v3/organizations/{orgId}/pages/{pageId}:
parameters:
- $ref: '#/components/parameters/orgId'
- name: pageId
description: >-
The page id, returned as `id` by `listPages` and `createPage`, or the
`page=` parameter of a page link.
in: path
required: true
schema:
type: string
format: uuid
patch:
tags:
- Pages
summary: Update a page
description: >-
Replaces a page's HTML and/or renames it as a new revision under the
same id: its link, share link and Library row stay, so one page stays
one page. Works on any page you may see, from any Session, as the
agent's app_show with page_id does; send the whole new page (getPage
with include=source gives back the current one). Checked as createPage
checks a page. Requires pages:write and a member who may write.
Scope: `pages:write`
operationId: updatePage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePage'
responses:
'200':
description: >-
The page at its new revision (the same revision when nothing
changed).
content:
application/json:
schema:
$ref: '#/components/schemas/Page'
'400':
description: Neither html nor title was sent, or one is invalid.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: >-
A required scope or workspace write permission is missing, or
pages_api is not on for this workspace (`pages_api_unavailable`).
'404':
description: No page with that id that you may see (`page_not_found`).
'409':
description: >-
The page is a document (`page_is_document`), or another update saved
first (`page_update_conflict`): read it again and resend.
'413':
description: The page is over 25 MiB with its images inlined.
'422':
description: >-
The page was refused: a live-page handler cannot run or it names
local images.
'429':
$ref: '#/components/responses/RateLimited'
'503':
description: Page storage is unavailable; try again.
security:
- reasonApiKey:
- pages:write
components:
parameters:
orgId:
name: orgId
in: path
required: true
description: Organization id or slug. Resolve it with `GET /v3/self`.
schema:
type: string
schemas:
UpdatePage:
type: object
properties:
html:
type: string
description: >-
The whole new page. Omit it to keep the current HTML and only
rename.
title:
type: string
description: A new name. Omit it to keep the page's current name.
height:
type: integer
description: The frame height in CSS pixels; omit it to fit the page.
description: At least one of html or title.
Page:
type: object
properties:
id:
type: string
description: >-
The page's id, from listPages, createPage or a page link's `page=`
parameter.
title:
type: string
description: The page's name.
revision:
type: integer
description: 1 when made, one more for each update under the same id.
kind:
type: string
enum:
- page
- document
description: >-
`page` for an HTML page; `document` for a Markdown document page,
which this API reads but does not write.
session_id:
type: string
description: The Session the page lives in.
url:
type: string
description: >-
The page's link in Reason: its Session opened on the page, for
anyone who may read that Session. It never changes.
view_url:
description: >-
A short-lived URL that serves the page itself for the caller
(sandboxed HTML); null for a document.
type:
- string
- 'null'
view_url_expires_at:
format: date-time
description: When `view_url` stops loading.
type:
- string
- 'null'
preview:
anyOf:
- $ref: '#/components/schemas/PagePreview'
- type: 'null'
description: >-
The hero picture of the current revision; null until one is captured
(the Library then renders the page live).
preview_capture:
type: string
enum:
- scheduled
- not_running
description: >-
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.
share:
$ref: '#/components/schemas/PageShare'
source:
type: string
description: >-
With include=source: the page's HTML as written (local images
inlined), or a document's Markdown.
PagePreview:
type: object
properties:
light:
type: string
description: Short-lived URL of the hero picture in the light theme (PNG, 2x).
dark:
type: string
description: Short-lived URL of the hero picture in the dark theme.
width:
type: number
description: The picture's width in CSS pixels.
height:
type: number
description: The picture's height in CSS pixels.
hero:
type: boolean
description: >-
True when the picture is the page's `[data-page-hero]`; false when
it is the top of the page.
PageShare:
type: object
properties:
visibility:
type: string
enum:
- private
- workspace
- link
description: >-
Who opens the share link: only the owner, any workspace member, or
anyone with the link.
url:
description: >-
The share link; null before the page was ever shared. Its token
never changes, so a link sent earlier opens again when sharing is
turned back on.
type:
- string
- 'null'
can_manage:
type: boolean
description: Whether the caller may change the share (only the page's owner may).
Error:
type: object
properties:
error:
oneOf:
- type: string
- type: object
required:
- type
- message
properties:
type:
type: string
message:
type: string
request_id:
type:
- string
- 'null'
message:
type: string
required_scope:
type: string
description: >-
The capability required when the request was denied for a missing
scope.
responses:
Unauthorized:
description: Missing, invalid, or expired key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: missing_bearer
message: Authorization required
RateLimited:
description: >-
Too many requests. Retry after the number of seconds in the
`Retry-After` response header.
headers:
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
minimum: 1
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: rate_limited
message: This API key exceeded its request-rate limit
securitySchemes:
reasonApiKey:
type: http
scheme: bearer
bearerFormat: 'reason_ (legacy: ara_)'
description: >-
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).
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.