# supermemory | Memory API for the AI era

> Frontier agent memory and context platform

## Docs

- [Introduction](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/index.md): Context infrastructure for AI agents
- [What is Supermemory?](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/overview/what-is-supermemory.md): Supermemory is the long term and short term context and memory infrastructure for agents.
- [Comparison - should I use supermemory?](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/overview/comparison.md): How Supermemory compares with a DIY vector stack, thin memory layers, pure RAG and building it yourself.
- [Quickstart](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/quickstart.md): Ingest a conversation and a document, retrieve them three ways, then wire it into a chat harness.
- [Agents, skills and MCP](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/agents-and-mcp.md): Set up coding agents to integrate Supermemory with the CLI, the skill and the docs MCP.
- [How Supermemory works](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/how-it-works.md): How a file or chat turn becomes something you can search: the ingest pipeline, statuses and outputs.
- [Graph memory](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/graph-memory.md): How facts connect, update and stay true: relationships, temporal truth and automatic forgetting.
- [Supported content types](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/content-types.md): All the content formats Supermemory can ingest and process
- [SuperRAG (managed RAG as a service)](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/super-rag.md): Supermemory provides a managed RAG solution - extraction, indexing, storing, and retrieval.
- [Memory vs RAG: Understanding the difference](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/memory-vs-rag.md): Learn why agent memory and RAG are fundamentally different, and when to use each approach
- [Multi-tenancy overview](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/multi-tenancy.md): How Supermemory isolates and organizes memories across users, tenants, and projects
- [Multi-tenancy examples](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/multi-tenancy-examples.md): Common namespace and metadata patterns for personal agents, company agents, email assistants, and support platforms
- [Namespaces](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/container-tags.md): Namespaces, formerly container tags, are the isolation boundary that partitions memories by user, project, or any logical scope
- [Organizing & filtering memories](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/filtering.md): Use namespaces and metadata to organize and retrieve memories
- [User profiles](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/user-profiles.md): Automatically maintained context about your users
- [Profile buckets](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/user-profiles/buckets.md): Custom topical categories for user profiles
- [Using Supermemory](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/using-supermemory.md): The full loop: authenticate, put context in, get it back out, keep it correct.
- [API keys & auth](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/authentication.md): Org API keys, namespace-scoped keys, and connector branding.
- [Invite team members](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/invite-team-members.md): Invite a colleague to your Supermemory organization, choose their access, and share the invitation link.
- [Customizing for your use case](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/customization.md): Configure Supermemory's behavior for your specific application
- [Ingesting context to supermemory](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/ingestion/add-memories.md): Add text, files, and URLs to Supermemory
- [Document operations](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/ingestion/document-operations.md): List, get, update, and delete your ingested documents
- [Connectors overview](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/overview.md): Integrate Google Drive, Gmail, Notion, OneDrive, GitHub, Granola and Web Crawler to automatically sync documents into your knowledge base
- [Notion connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/notion.md): Sync Notion pages, databases, and blocks with real-time webhooks and workspace integration
- [Google Drive connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/google-drive.md): Connect Google Drive to sync documents into your Supermemory knowledge base
- [Gmail connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/gmail.md): Sync email threads from Gmail with real-time Pub/Sub webhooks and incremental sync
- [OneDrive connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/onedrive.md): Sync Microsoft Office documents from OneDrive with scheduled synchronization and business account support
- [S3 Connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/s3.md): Connect Amazon S3 or S3-compatible storage to sync files into your Supermemory knowledge base
- [Granola connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/granola.md): Sync AI meeting notes and transcripts from Granola into your Supermemory knowledge base
- [GitHub connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/github.md): Connect GitHub repositories to sync documentation files into your Supermemory knowledge base
- [Web Crawler connector](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/web-crawler.md): Crawl and sync websites automatically with scheduled recrawling and robots.txt compliance
- [Connector troubleshooting](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/troubleshooting.md): Diagnose and resolve common issues with Google Drive, Gmail, Notion, and OneDrive connectors
- [Managing Connector Selection](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/connectors/managing-resources.md): Choose what a connector syncs with the hosted picker or a direct selection update
- [Search](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/recall/search.md): Semantic search across your memories and documents
- [User profiles](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/recall/user-profiles.md): Fetch and use automatically maintained user context
- [Memory Operations](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/recall/memory-operations.md): Forget extracted memories exactly or by meaning
- [Review inferred memories](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/recall/memory-review.md): List low-confidence inferred memories, then approve, decline or undo them.
- [SMFS](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/overview.md): Memory your agent can grep.
- [Install SMFS](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/install.md): Install, log in, mount.
- [Mount](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/mount.md): Mount a Supermemory container, generate memories, and sync.
- [Bash tool](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/bash-tool.md): @supermemory/bash. The SMFS idea wrapped as a single agent tool, for serverless and edge runtimes.
- [Bash tool (Python)](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/bash-tool-python.md): supermemory-bash. The SMFS idea wrapped as a single agent tool, for Python agents and serverless runtimes.
- [Daytona](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/providers/daytona.md): Give your AI agent persistent memory inside a Daytona sandbox using SMFS
- [E2B](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/providers/e2b.md): Give your AI agent persistent memory inside an E2B sandbox using SMFS
- [Vercel AI SDK](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/providers/vercel.md): Give your AI agent persistent memory using SMFS with the Vercel AI SDK
- [Cloudflare](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/providers/cloudflare.md): Give your AI agent persistent memory inside a Cloudflare Container using SMFS
- [Examples](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/smfs/examples.md): Full web-based demo apps you can clone and run.
- [Rules of supermemory](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/concepts/rules.md): Best practices and things to consider when using supermemory in your system
- [Supermemory local](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/self-hosting/overview.md): State-of-the-art memory, running on your machine. One binary, zero config.
- [Self-hosting quickstart](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/self-hosting/quickstart.md): From zero to your first memory in under two minutes.
- [Self-hosting configuration](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/self-hosting/configuration.md): Every environment variable the self-hosted server understands.
- [Embeddings (self-hosted)](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/self-hosting/embeddings.md): Local and remote embedding providers for Supermemory local: defaults, env vars, multilingual options and dimension lock.
- [Using supermemory local with different providers](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/self-hosting/providers.md): Copy-paste .env setup for Ollama, OpenAI, Anthropic, Gemini, and OpenRouter
- [Local vs. Enterprise](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/self-hosting/local-vs-enterprise.md): Supermemory local is for builders. Supermemory Enterprise is for organizations.
- [How to backfill historical data into Supermemory](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/ingestion/batch-ingest-historical-data.md): Backfill historical documents into Supermemory with date, stable IDs, and the batch ingestion API.
- [MemoryBench](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/memorybench/overview.md): Open-source framework for benchmarking memory providers, including your own.
- [Building a benchmark](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/memorybench/extend-benchmark.md): Add a custom benchmark dataset when the built-in ones don't match your use case
- [Adding a provider](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/memorybench/extend-provider.md): Register your own memory implementation so MemoryBench can score and compare it
- [Measuring results](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/memorybench/memscore.md): How MemoryBench scores a run with qualitative judging and quantitative metrics.
- [Billing & usage](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/overview/billing.md): How Supermemory metering works: SM tokens, operations, search, SuperRAG, plans, diff billing and the usage APIs.
- [Security & compliance](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/overview/security.md): How Supermemory protects data: encryption, isolation, SOC 2, GDPR, HIPAA BAA and deletion.
- [Use cases](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/overview/use-cases.md): What teams build with Supermemory: agents, knowledge bases, multi-tenant products and tools.
- [Analytics & monitoring](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/overview/analytics.md): Observe usage, errors, and logs to monitor your Supermemory integration
- [Migrate Supermemory v3/v4 to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5.md): Upgrade legacy API calls to the namespace-scoped v5 API
- [Migrate document ingestion to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-document-writes.md): Upgrade single, batch, and file ingestion without changing append behavior
- [Migrate document and file updates to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-document-updates.md): Choose append, replacement, or metadata-only updates deliberately
- [Migrate content management to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-document-reads.md): Upgrade document retrieval, resource lists, and document or memory deletion
- [Migrate search to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-recall.md): Upgrade search modes, filters, included context, defaults, and response readers
- [Migrate profiles and buckets to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-profiles.md): Separate profile retrieval from search and manage namespace-owned buckets
- [Migrate memory forgetting to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-memory-forgetting.md): Replace legacy exact and semantic forgetting with one response contract
- [Migrate container tags to namespaces](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-settings.md): Upgrade namespace discovery, settings, deletion, and moves
- [Migrate organization settings to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-organization.md): Reduce organization settings to shared context and namespace count
- [Migrate metadata filters to v5](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-filters.md): Convert legacy Query filters into strict, type-safe v5 filter expressions
- [Verify and roll out a v5 migration](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/api-v5-rollout.md): Prove behavioral parity, detect intentional differences, and cut over safely
- [Migrating from Mem0 to Supermemory](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/from-mem0.md): Complete guide to migrate your data and applications from Mem0 to Supermemory
- [Migrating from Zep to Supermemory](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/from-zep.md): Quick guide to migrate from Zep to Supermemory
- [Supermemory SDK](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/supermemory-sdk.md): Official Python and JavaScript SDKs for Supermemory
- [Vercel AI SDK](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/ai-sdk.md): Use Supermemory with Vercel AI SDK for seamless memory management
- [Eve](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/eve.md): Give your Eve agent memory across conversations with Supermemory.
- [OpenAI SDK](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/openai.md): Memory tools for OpenAI function calling with Supermemory integration
- [LangGraph](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/langgraph.md): Add persistent memory to LangGraph agents with Supermemory
- [OpenAI Agents SDK](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/openai-agents-sdk.md): Add persistent memory to OpenAI agents with Supermemory
- [Microsoft Agent Framework](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/agent-framework.md): Add persistent memory to Microsoft Agent Framework agents with Supermemory
- [Mastra](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/mastra.md): Add persistent memory to Mastra AI agents with Supermemory processors
- [VoltAgent](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/voltagent.md): Integrate Supermemory with VoltAgent for long-term memory in AI agents
- [Convex](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/convex.md): Add persistent memory to Convex apps with Supermemory
- [LangChain](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/langchain.md): Build AI agents with persistent memory using LangChain and Supermemory
- [CrewAI](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/crewai.md): Add persistent memory to CrewAI agents with Supermemory
- [Agno](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/agno.md): Add persistent memory to Agno agents with Supermemory
- [Memory Graph](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/memory-graph.md): Interactive visualization for documents, memories and connections
- [Claude Memory Tool](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/claude-memory.md): Use Claude's native memory tool with Supermemory as the backend
- [Pipecat](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/pipecat.md): Integrate Supermemory with Pipecat for conversational memory in voice AI agents
- [Cartesia](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/cartesia.md): Integrate Supermemory with Cartesia for conversational memory in voice AI agents
- [LiveKit](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/livekit.md): Add persistent memory to LiveKit Agents voice sessions
- [n8n](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/n8n.md): Automate knowledge management with Supermemory in n8n workflows
- [viaSocket](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/viasocket.md): Connect Supermemory with viaSocket to build automation flows using triggers, API tokens, and actions like Gmail.
- [Zapier](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/zapier.md): Automate memory management with Supermemory in Zapier workflows
- [Upgrading @supermemory/tools to 3.0](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/tools-v3-upgrade.md): Migrate from @supermemory/tools 2.x to 3.0: one namespace per config, v5 option names, conversations stored as documents.
- [Upgrading @supermemory/tools to v2.0.0](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/migration/tools-v2-upgrade.md): Migrate from @supermemory/tools 1.4.x to 2.0.0: the config-object signature, customId and new defaults.
- [API reference](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/overview.md): Documents, search, profiles, lists, memories, namespaces, and organization settings in the latest Supermemory API
- [Ingest](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/ingest.md): Turn source content into searchable memory and keep it current
- [Content management](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/content-management.md): Retrieve, list, and remove documents, chunks, and memories
- [Search](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/search.md): Recall the most relevant memories and source context
- [Profiles](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/profiles.md): Turn accumulated memory into a ready-to-use understanding of a user
- [Namespaces](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/namespaces.md): Keep memory isolated, understandable, and easy to reorganize
- [Connectors](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/connectors.md): Sync Notion, Google Drive, Gmail, GitHub, websites, S3 buckets, and Granola into a namespace
- [Organization](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/v5/api-reference/organization.md): Give every namespace a shared understanding of your organization
- [Overview](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/supermemory-mcp/mcp.md): Give every MCP-compatible assistant shared memory, team spaces, and interactive workflows
- [Setup and usage](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/supermemory-mcp/setup.md): Connect Supermemory to an MCP client with OAuth and choose how requests use spaces
- [ChatGPT Web](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/supermemory-mcp/chatgpt-web.md): Connect Supermemory MCP to ChatGPT Web and make Supermemory the default for memory, recall, and saved context
- [Claude Desktop](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/supermemory-mcp/claude-desktop.md): Connect Supermemory MCP in Claude via Settings → Connectors
- [OpenClaw](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/openclaw.md): Supermemory plugin for OpenClaw. Works across Telegram, WhatsApp, Discord, Slack and more.
- [Hermes](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/hermes.md): Supermemory plugin for Hermes. Semantic memory, profiles and search across Telegram, Discord, Slack, the CLI and more.
- [Claude Code](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/claude-code.md): Supermemory plugin for Claude Code. Keeps memory across coding sessions.
- [Muse Code](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/muse-code.md): Persistent memory for Meta Muse Code with the muse-supermemory plugin.
- [Codex](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/codex.md): Persistent memory for the OpenAI Codex CLI with the codex-supermemory plugin.
- [OpenCode](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/opencode.md): Supermemory plugin for OpenCode. Keeps memory across coding sessions.
- [Cursor](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/cursor.md): cursor-supermemory: persistent memory across your Cursor chats
- [Grok Bot](https://supermemory-mtd-v5-docs-sdk-shape.mintlify.site/integrations/grok-bot.md): Supermemory for Grok Bot: persistent memory for your Grok Bots


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.