Getting Started
Key Features
This is the verified feature inventory for the MemorySync API. Every section below maps to a real, mounted route.
Memory API surface
| Endpoint | Verified purpose |
|---|---|
POST /memory/add | Create memories through the extraction pipeline. |
POST /memory/query | Run semantic retrieval. |
POST /memory/retrieve | Compatibility alias for callers that expect retrieve. |
POST /memory/summarize | Summarize existing memories. |
DELETE /memory/forget | Delete selected memories. |
GET /memory/export | Export stored memories. |
POST /memory/refresh | Trigger asynchronous embedding refresh. |
DELETE /memory/user/purge | Purge all memory data for the authenticated user. |
Retrieval and read-model endpoints
| Endpoint | What it returns |
|---|---|
POST /memory/compose | Prompt composition result. |
POST /memory/search/routed | Routed query response. |
GET /memory/graph | Graph response. |
GET /memory/clusters | Clusters response. |
GET /memory/decisions | Decision panel response. |
GET /memory/intelligence | Intelligence response. |
Identity, org, and project features
- Email and password auth lives under
/auth/*. - API-key management lives under
/org/api-keys. - Project CRUD lives under
/org/projects. - Project resolution and enforcement run before route handlers on project-scoped endpoints.
Integrations, crawler, and webhooks
| Surface | Verified implementation |
|---|---|
| Sync providers | GitHub, Notion, Google Drive, and OneDrive. |
| Integrations API | Mounted under /api/v1/integrations. |
| Web crawler | Mounted under /api/v1 through the crawler router. |
| Webhooks | Mounted under /org/webhooks. |
Enterprise and operations surface
- Billing routes are mounted at
/org/billing. - SCIM v2 is mounted at
/scim/v2. - SSO login routes exist for SAML and OIDC.
- OAuth browser flow lives at
/oauth/authorize. - The dashboard and docs UI run as a separate application from the API.
Runtime behaviour visible to callers
- Add and query routes are quota-gated before the main handler logic executes.
- When the org is over its add or query quota, add silently returns
{"status":"ok"}and query silently returns{"memories":[]}— no error is surfaced to the caller. - Project-locked API keys can satisfy project enforcement without an explicit
X-Project-IDheader.