Skip to main content
This is the legacy v3/v4 reference. v3 and v4 are deprecated and will be shut down on December 31, 2026. Move to v5 before then. The migration guide maps every legacy call to its v5 equivalent.
This is the contract-level reference for Supermemory: methods, paths, parameters, and the playground. For narrative guides (when to use what, patterns, SDKs), start with the Quickstart and Using supermemory.

​
Base URL

Self-hosted: use your instance URL (for example http://localhost:6767). See Self-hosting.

​
Authentication

All endpoints use a Bearer API key. Create one in the developer console.
Details: API keys & auth.

​
Mental model

Same containerTag scopes ingest, search, and profiles — one engine, multiple ways out.

​
Suggested order

  1. Ingest — POST /v3/documents (SDK: client.add)
  2. Documents — GET /v3/documents/{id} until status: "done"
  3. Search — POST /v4/search
  4. Profiles — POST /v4/profile
Full walkthrough with conversation + document examples: Quickstart.

​
SDKs

Official clients wrap this API:
  • TypeScript: npm install supermemory
  • Python: pip install supermemory
See Supermemory SDK. Playground snippets come from the OpenAPI spec: official TypeScript / Python SDK samples via x-codeSamples, plus cURL. (After API deploy — until then you may still see generic HTTP snippets.) SDK generation is migrating off Stainless SaaS to stlc soon; documented OpenAPI samples will then be produced by the SDK build instead of a hand-maintained map.

​
OpenAPI

Spec (live): https://api.supermemory.ai/v3/openapi