Memory
Operations of the Memory API. Paths are relative to your deployment's API host.
GET /api/memory-api/memory/file
Fetch the full markdown body + audit metadata for one memory.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
path | query | string | yes | Canonical memory path, e.g. /memories/project/lesson/foo.md |
| Status | Description | Body |
|---|---|---|
| 200 | application/json MemoryDetailDtoDataEnvelope |
POST /api/memory-api/memory/file
Create a new memory file. Same path grammar + scope rules as the MCP memory_create tool.
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json CreateMemoryBodyDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json MemorySummaryDtoDataEnvelope |
PATCH /api/memory-api/memory/file
Replace oldStr with newStr in a memory file. The match must be unique within the body.
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json StrReplaceBodyDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json MemorySummaryDtoDataEnvelope |
DELETE /api/memory-api/memory/file
Delete a memory file.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
path | query | string | yes | Canonical memory path, e.g. /memories/project/lesson/foo.md |
| Status | Description | Body |
|---|---|---|
| 204 |
POST /api/memory-api/memory/file/append
Append a new ledger entry to an existing memory. The server stamps the ## <ISO-8601> heading.
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json AppendEntryBodyDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json MemorySummaryDtoDataEnvelope |
POST /api/memory-api/memory/file/rename
Rename a memory slug. Scope + kind segments are immutable; only the slug changes.
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json RenameMemoryBodyDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json MemorySummaryDtoDataEnvelope |
GET /api/memory-api/memory/list
Flat list of memories visible to the caller (org + active project + own user). Optional filters: scope, kind, tags, projectSlug for cross-project read.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | MemoryKind | no | |
ownerSpaceKind | query | one of "org", "project", "user" | no | |
projectSlug | query | string | no | Other-project slug — read-only access if the actor is a member. |
tags | query | array of string | no |
| Status | Description | Body |
|---|---|---|
| 200 | application/json MemoryListResponseDtoDataEnvelope |
GET /api/memory-api/memory/projects
List projects the current human actor can read memories from.
Authentication: bearer token (Authorization: Bearer <token>)
| Status | Description | Body |
|---|---|---|
| 200 | application/json MemoryProjectListResponseDtoDataEnvelope |
GET /api/memory-api/memory/search
Vector search across memories the caller can read. Returns the same row shape as GET /memory/list.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | MemoryKind | no | |
limit | query | number | no | |
ownerSpaceKind | query | one of "org", "project", "user" | no | |
query | query | string | yes | |
tags | query | array of string | no |
| Status | Description | Body |
|---|---|---|
| 200 | application/json MemorySearchResponseDtoDataEnvelope |