Getting Started
Why MemorySync
MemorySync is more than a memory add and query API. The product also covers project scoping, identity, integrations, billing, and enterprise controls around that core.
The service surface beyond memory writes
| Route family | Why it matters |
|---|---|
/memory/* | Core storage, retrieval, summarize, compose, routed search, graph, clusters, decisions, and intelligence endpoints. |
/auth/* and /org/api-keys | Built-in session auth and service-auth. |
/org/projects | Project namespaces are explicit backend objects. |
/org/billing | Billing is a mounted route group, not an external note. |
/org/webhooks and /api/v1/integrations | External systems are part of the product surface. |
What the backend enforces around requests
- Authentication resolves before the memory handlers run.
- Project scope is enforced on project-scoped routes before the handler runs.
- Quota checks run before both
/memory/addand/memory/query. - Service-auth memory callers must identify the end user with
X-End-User-IDorend_user_id. - The add route overwrites client-supplied
user_id,environment, andproject_idwith trusted request context.
Verified external systems
| Area | Verified implementation |
|---|---|
| Sync providers | GitHub, Notion, Google Drive, and OneDrive. |
| Web crawler | Mounted under /api/v1. |
| Webhooks | Org-level webhook routes are mounted under /org. |
| Identity | SAML, OIDC, OAuth browser flow, and SCIM v2 are all mounted. |
Operational surface
- Billing routes are mounted at
/org/billing. - Webhooks are delivered asynchronously after the originating request returns.
What to verify before production
Evaluate the API and SDK behavior, tenant and project scoping, quotas, retention, integration permissions, and operational controls against your own workload and contract. Product pages do not replace deployment-specific testing.