> ## 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.
# Write a memory file
> Creates a file or replaces its whole text. Reasons read the change from their next Session on: `MEMORY.md` is in every Session's starting context, so keep it short and put detail in topic notes, which a Session reads when it needs them.
Personal memory is the caller's own; team memory takes direct writes only from a Workspace owner or admin (403 for other members). The change is stored as a revision under the caller's name with no source Session, so it shows in memory history and can be restored. Paths are normalized (lower case, `.md` added); empty text (for a note), text over the size limit (32 KiB a note, 12 KiB `MEMORY.md`), or text holding a secret or instructions aimed at a later Session is refused with 422, and a new note in a folder that already holds 200 answers 409. Personal memory that its owner turned off cannot change (409 `memory_disabled`).
Scope: `memory:write`
## OpenAPI
````yaml /openapi.json put /v3/organizations/{orgId}/memory/file
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: 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}/memory/file:
parameters:
- $ref: '#/components/parameters/orgId'
put:
tags:
- Memory
summary: Write a memory file
description: >-
Creates a file or replaces its whole text. Reasons read the change from
their next Session on: `MEMORY.md` is in every Session's starting
context, so keep it short and put detail in topic notes, which a Session
reads when it needs them.
Personal memory is the caller's own; team memory takes direct writes
only from a Workspace owner or admin (403 for other members). The change
is stored as a revision under the caller's name with no source Session,
so it shows in memory history and can be restored. Paths are normalized
(lower case, `.md` added); empty text (for a note), text over the size
limit (32 KiB a note, 12 KiB `MEMORY.md`), or text holding a secret or
instructions aimed at a later Session is refused with 422, and a new
note in a folder that already holds 200 answers 409. Personal memory
that its owner turned off cannot change (409 `memory_disabled`).
Scope: `memory:write`
operationId: writeMemoryFile
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WriteMemoryFile'
example:
scope: personal
path: web-app.md
content: |
# Web app
- Run `bun run test` before opening a pull request.
responses:
'200':
description: The file as stored.
content:
application/json:
schema:
$ref: '#/components/schemas/MemoryWriteResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'409':
$ref: '#/components/responses/Conflict'
'422':
description: >-
The content was refused: empty, too large, holding a secret, or
instructions aimed at a later Session. `message` says what to
change.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
$ref: '#/components/responses/RateLimited'
security:
- reasonApiKey:
- memory: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:
WriteMemoryFile:
type: object
properties:
scope:
type: string
enum:
- personal
- team
description: >-
`personal`: the memory of the person the API key or OAuth grant
belongs to, private to them. `team`: the Workspace's shared team
memory, which every member's Sessions read.
path:
type: string
description: >-
The file's path within the scope: `MEMORY.md` (the index) or a note
such as `web-app.md`. A name without an extension gets `.md`, and
paths are lower case, so `Web-App` and `web-app.md` are one note.
Personal notes may sit in up to three folders
(`projects/web-app.md`); team notes sit at the top or in a place
folder such as `reasons//`. A `memory:/` or `team:/` prefix is
accepted and ignored.
content:
type: string
description: >-
The file's complete new text; it replaces what the file holds. A
note needs some text and at most 32 KiB; `MEMORY.md` at most 12 KiB.
Text holding a secret, or instructions aimed at a later Session, is
refused.
expected_revision_id:
description: >-
The `revision_id` of the file as last read: the write is refused
with 409 when the file has changed since. `null` requires that the
file does not exist yet. Leave it out to replace whatever the file
holds.
type:
- string
- 'null'
required:
- scope
- path
- content
MemoryWriteResponse:
type: object
properties:
scope:
type: string
enum:
- personal
- team
description: >-
`personal`: the memory of the person the API key or OAuth grant
belongs to, private to them. `team`: the Workspace's shared team
memory, which every member's Sessions read.
file:
$ref: '#/components/schemas/MemoryFile'
updated:
type: boolean
description: False when the file already held this text, so nothing changed.
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.
MemoryFile:
type: object
properties:
path:
type: string
content:
type: string
byte_length:
type: integer
updated_at:
type:
- string
- 'null'
format: date-time
revision_id:
description: >-
The revision this text is; send it as `expected_revision_id` to
write only if nobody changed the file since.
type:
- string
- 'null'
responses:
BadRequest:
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: prompt_required
Unauthorized:
description: Missing, invalid, or expired key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: missing_bearer
message: Authorization required
Forbidden:
description: The key lacks the required scope or role.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: missing_scope
required_scope: sessions:read
Conflict:
description: The request conflicts with the current resource state.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: last_owner
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, knowledge:read, memory:read, memory:write, skills:read,
skills: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.
network:read and network:write are opt-in, excluded from default keys.
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.