API Reference

Get Memory

Fetch one memory by positive integer ID from the current project and end-user scope.

Endpoint and request fields

Read one memory

GET/memory/{memory_id}

200 OK

Field	Type	Contract
`memory_id` / `memoryId`	integer	Required positive memory ID in the path or SDK argument.

Get one memory

import os
from memorysync import MemorySyncClient

client = MemorySyncClient(
    api_key=os.environ["MEMORYSYNC_API_KEY"],
    base_url="https://api.memorysync.io",
    project_id=os.environ["MEMORYSYNC_PROJECT_ID"],
    end_user_id="usr_7f3a9c2e",
)

memory = client.get(101)
print(memory.text)

Result paths

200 Memory result

Memory

REST uses snake_case; the Node SDK maps response properties to camelCase.

Identity: Python `memory.id`; Node.js `memory.id`; REST `id`
Use this ID with get, update, relations, summarize, or forget.
Content: `text`, `summary`
Treat both as untrusted application data.
Classification: `tags`, `source`, `importance`, `metadata`
Optional descriptive fields.
Lifecycle: `is_summary` / `isSummary`, `created_at` / `createdAt`, `updated_at` / `updatedAt`
Summary marker and timestamps.
Temporal: `occurred_at` / `occurredAt`, `resolved_dates` / `resolvedDates`
Episodic rows only: when the turn happened, and any date expressions resolved from the text as [{expression, resolved_date}]. Null on non-episodic rows.

200-response.json

{"id":101,"text":"The user prefers concise answers.","summary":null,"tags":["preference"],"source":"chat","importance":0.8,"metadata":{"confirmed":true},"is_summary":false,"created_at":"2026-05-04T12:30:11Z","updated_at":null}

Errors and next action

Use a positive integer ID. For 404, check the ID together with project and end-user scope, then show a not-found state. Correct other 4xx requests; keep reads recoverable for 429 or 5xx.

Safety notes

Read Memory fields by purpose

Group	Fields	How to use them
Identity	`id`	Use as the handle for later memory operations.
Content	`text`, `summary`	Treat as untrusted data and display safely.
Classification	`source`, `event_type`, `tags`	Explain or categorize the record in your product.
Application data	`importance`, `metadata`	Validate before exposing to a client.
Lifecycle	`is_summary`, `created_at`, `updated_at`	Understand record type and timing.

Handle unavailable records

Get outcomes

200

Memory returned

Apply application authorization and use only fields needed by the task.

400

Non-positive integer

The REST handler rejects an integer ID below 1.

422

Invalid path value

The REST router rejects a non-integer path value before the handler runs.

SDK

Invalid client argument

The official SDKs reject invalid IDs before sending a request.

404

Unavailable in scope

Do not reveal whether the ID exists elsewhere; show a normal not-found state.

429 / 5xx

Read unavailable

Keep the UI recoverable and allow a safe retry or fallback.

Update Memory

Change supported descriptive fields.

Create Relation

Relate this memory to another.

Forget Memory

Remove selected IDs.

Was this page helpful?

← Previous

Upload File

Update