Core capabilities
- Store user-specific memories with
/api/Memory/write, tagging and scoping them per user or project. - Retrieve relevant facts in real time with
/api/Memory/recalland refine results with thresholds and tags. - Summarize & explore topics with
/api/Memory/recall-summaryand/api/Memory/recall-topicsto power profile views. - Administer the dataset with
/api/Memory/deleteand/api/Memory/export(Manager role required).
Endpoint quick reference
| Use case | Endpoint | Method | Key inputs |
|---|---|---|---|
| Add a new memory for a user or project | /api/Memory/write | POST | Body fields: userId, content, consentFlag, optional projectId, tags, metadata |
| Search for the most relevant memories | /api/Memory/recall | POST | Query params: summarized, reRank, type, similarityThreshold, limit; body: query, scope, userId, projectId, optional tags |
| Get a condensed view of all facts | /api/Memory/recall-summary | POST | Body: scope, userId, projectId, optional tags |
| Discover topics extracted from memories | /api/Memory/recall-topics | POST | Body: userId, optional projectId |
| Remove memories for a scope | /api/Memory/delete | DELETE | Body: scope, optional userId, projectId |
| Export memories for compliance or BI | /api/Memory/export | GET | Query params: Type, Format, optional UserId, ProjectId, StartDate, EndDate |
Before you start
- Generate an API key and store it securely. Keys map to a role; choose Manager if you need deletion or export access.
- Align on consent. The
consentFlagfield must betruefor every stored memory to meet compliance requirements. - Decide on scoping. Use
projectIdto partition memories per environment, and uniqueuserIdvalues for personalized recall.
Where to go next
Memory Kick Start
Learn how to write your first memory and retrieve it with
/api/Memory/recall.Memory Deep Dive
Explore payload schemas, query tuning, and admin workflows for Memory.

