Documentation
Introduction
MemorySync is a memory API service. It stores text memories, queries them semantically, and surrounds that core with authentication, project scoping, integrations, billing, SSO, SCIM, and OAuth flows.
What MemorySync includes
MemorySync covers memory operations, auth, projects, API keys, billing, SSO, SCIM, OAuth, webhooks, integrations, web crawler, analytics, and more.
- The dashboard and docs site run as a separate application.
- The service stack includes a relational database, a vector store, a cache layer, and background job workers.
- All endpoints return JSON and follow standard HTTP conventions.
What every request is scoped by
| Piece | How it is set | Why it matters |
|---|---|---|
| Authentication | Authorization: Bearer ... or X-API-Key | Routes depend on auth and scope helpers before business logic runs. |
| Project | X-Project-ID header or a project-locked API key | Project-scoped endpoints require a project to be resolved before the request runs. |
| End user | JWT user id or X-End-User-ID for API-key callers | The memory routes resolve the effective owner server-side. |
| Memory body | text or alias content, plus optional metadata | The request schema validates text and normalizes content into text. |
Core memory routes
| Route | What it does |
|---|---|
POST /memory/add | Create one or more stored memories through the extraction pipeline. |
POST /memory/query | Run semantic retrieval for the authenticated user or resolved end user. |
POST /memory/summarize | Summarize a list of memory ids. |
DELETE /memory/forget | Delete selected memories. |
POST /memory/compose | Build a prompt by retrieving memories into a token budget. |
POST /memory/search/routed | Route a query through the structured query router. |
GET /memory/graph, /clusters, /decisions, /intelligence | Read richer derived views built on stored memories. |
Where to start reading
| If you want to… | Read this next |
|---|---|
| Understand headers, tokens, and API keys | Authentication Setup |
| Send one real add/query request | Quickstart (5 min) |
| See the mounted route groups | API Overview |
| See how the backend is wired | Architecture Overview |
| Inspect the verified feature surface | Key Features |