From e19b748ad00a1bf355fc7ab5549f848caa4cb938 Mon Sep 17 00:00:00 2001 From: Parshva Daftari <89991302+parshvadaftari@users.noreply.github.com> Date: Wed, 1 Oct 2025 23:10:27 +0530 Subject: [PATCH] Refactor docs and fix get memories playground (#3527) --- docs/api-reference.mdx | 45 +- docs/api-reference/memory/add-memories.mdx | 10 +- docs/api-reference/memory/v1-get-memories.mdx | 4 - .../memory/v1-search-memories.mdx | 4 - docs/api-reference/memory/v2-get-memories.mdx | 8 + .../memory/v2-search-memories.mdx | 8 + docs/docs.json | 1303 +++++++++-------- docs/examples.mdx | 110 +- docs/examples/aws_example.mdx | 2 +- .../aws_neptune_analytics_hybrid_store.mdx | 2 +- .../personalized-search-tavily-mem0.mdx | 2 +- docs/integrations/google-ai-adk.mdx | 4 +- docs/introduction.mdx | 4 + docs/openapi.json | 288 ++-- docs/v0x/examples/aws_example.mdx | 2 +- .../aws_neptune_analytics_hybrid_store.mdx | 2 +- .../personalized-search-tavily-mem0.mdx | 2 +- docs/v0x/integrations/google-ai-adk.mdx | 4 +- 18 files changed, 938 insertions(+), 866 deletions(-) delete mode 100644 docs/api-reference/memory/v1-get-memories.mdx delete mode 100644 docs/api-reference/memory/v1-search-memories.mdx diff --git a/docs/api-reference.mdx b/docs/api-reference.mdx index 73a9bc059..4b402b28d 100644 --- a/docs/api-reference.mdx +++ b/docs/api-reference.mdx @@ -6,26 +6,49 @@ iconType: "solid" Mem0 provides a powerful set of APIs that allow you to integrate advanced memory management capabilities into your applications. Our APIs are designed to be intuitive, efficient, and scalable, enabling you to create, retrieve, update, and delete memories across various entities such as users, agents, apps, and runs. -## Key Features +## Quick Start Guide -- **Memory Management**: Add, retrieve, update, and delete memories with ease. -- **Entity-based Operations**: Perform operations on memories associated with specific users, agents, apps, or runs. -- **Advanced Search**: Utilize our search API to find relevant memories based on various criteria. -- **History Tracking**: Access the history of memory interactions for comprehensive analysis. -- **User Management**: Manage user entities and their associated memories. +Get started with Mem0 API in three simple steps: + +1. **[Add Memories](/api-reference/memory/add-memories)** - Store information and context from user conversations +2. **[Search Memories](/api-reference/memory/v2-search-memories)** - Retrieve relevant memories based on queries +3. **[Get Memories](/api-reference/memory/v2-get-memories)** - Fetch all memories for a specific entity + +### Common Operations + + + + Store new memories from conversations and interactions + + + Find relevant memories using semantic search + + + Modify existing memory content + + + Remove specific memories or batch delete + + ## API Structure Our API is organized into several main categories: -1. **Memory APIs**: Core operations for managing individual memories and collections. -2. **Entities APIs**: Manage different entity types (users, agents, etc.) and their associated memories. -3. **Search API**: Advanced search functionality to retrieve relevant memories. -4. **History API**: Track and retrieve the history of memory interactions. +1. **[Memory APIs](#memory-apis)**: Core operations for managing individual memories and collections +2. **[Entities APIs](#entities-apis)**: Manage different entity types (users, agents, etc.) and their associated memories +3. **[Organizations APIs](#organizations-apis)**: Manage organizations and their members (optional) +4. **[Project APIs](#project-apis)**: Manage projects within organizations (optional) ## Authentication -All API requests require authentication using HTTP Basic Auth. Ensure you include your API key in the Authorization header of each request. +All API requests require authentication using Token-based authentication. Include your API key in the Authorization header: + +```bash +Authorization: Token +``` + +Get your API key from the [Mem0 Dashboard](https://app.mem0.ai/dashboard/api-keys). ## Organizations and projects (optional) diff --git a/docs/api-reference/memory/add-memories.mdx b/docs/api-reference/memory/add-memories.mdx index 12d4df50c..ae95f1c20 100644 --- a/docs/api-reference/memory/add-memories.mdx +++ b/docs/api-reference/memory/add-memories.mdx @@ -1,4 +1,12 @@ --- title: 'Add Memories' openapi: post /v1/memories/ ---- \ No newline at end of file +--- + +## Graph Memory + +To enable graph-based memory relationships, pass the `enable_graph=True` parameter. This creates relationships between entities in your memories for more contextual retrieval. + + +Learn more in the [Graph Memory documentation](/platform/features/graph-memory). + \ No newline at end of file diff --git a/docs/api-reference/memory/v1-get-memories.mdx b/docs/api-reference/memory/v1-get-memories.mdx deleted file mode 100644 index 29b664ee7..000000000 --- a/docs/api-reference/memory/v1-get-memories.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Get Memories (v1 - Deprecated)' -openapi: get /v1/memories/ ---- diff --git a/docs/api-reference/memory/v1-search-memories.mdx b/docs/api-reference/memory/v1-search-memories.mdx deleted file mode 100644 index c64406578..000000000 --- a/docs/api-reference/memory/v1-search-memories.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Search Memories (v1 - Deprecated)' -openapi: post /v1/memories/search/ ---- diff --git a/docs/api-reference/memory/v2-get-memories.mdx b/docs/api-reference/memory/v2-get-memories.mdx index 26d173113..7f5e8f932 100644 --- a/docs/api-reference/memory/v2-get-memories.mdx +++ b/docs/api-reference/memory/v2-get-memories.mdx @@ -63,3 +63,11 @@ memories = m.get_all( ) ``` + +## Graph Memory + +To retrieve memories with graph-based relationships, pass the `enable_graph=True` parameter. This includes relationship data in the response for more contextual results. + + +Learn more in the [Graph Memory documentation](/platform/features/graph-memory). + diff --git a/docs/api-reference/memory/v2-search-memories.mdx b/docs/api-reference/memory/v2-search-memories.mdx index 49ed89e9c..98d20d865 100644 --- a/docs/api-reference/memory/v2-search-memories.mdx +++ b/docs/api-reference/memory/v2-search-memories.mdx @@ -106,3 +106,11 @@ personal_memories = m.search( ) ``` + +## Graph Memory + +To retrieve memories with graph-based relationships, pass the `enable_graph=True` parameter. This includes relationship data in the response for more contextual results. + + +Learn more in the [Graph Memory documentation](/platform/features/graph-memory). + diff --git a/docs/docs.json b/docs/docs.json index 0f1d0f10a..e14429538 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -1,653 +1,654 @@ { - "$schema": "https://mintlify.com/docs.json", - "name": "Mem0", - "description": "Mem0 is a self-improving memory layer for LLM applications, enabling personalized AI experiences that save costs and delight users.", - "theme": "aspen", - "colors": { - "primary": "#2553eb", - "light": "#6084fa", - "dark": "#2553eb" - }, - "favicon": "/logo/favicon.png", - "navigation": { - "versions": [ - { - "version": "v1.0.0 Beta", - "anchors": [ - { - "anchor": "Documentation", - "icon": "book-open", - "tabs": [ - { - "tab": "Documentation", - "groups": [ - { - "group": "Getting Started", - "icon": "rocket", - "pages": [ - "introduction", - "quickstart", - "faqs" - ] - }, - { - "group": "Core Concepts", - "icon": "brain", - "pages": [ - "core-concepts/memory-types", - { - "group": "Memory Operations", - "icon": "gear", - "pages": [ - "core-concepts/memory-operations/add", - "core-concepts/memory-operations/search", - "core-concepts/memory-operations/update", - "core-concepts/memory-operations/delete" - ] - } - ] - }, - { - "group": "Platform", - "icon": "globe", - "pages": [ - "platform/overview", - "platform/quickstart", - "platform/advanced-memory-operations", - { - "group": "Features", - "icon": "star", - "pages": [ - "platform/features/platform-overview", - "platform/features/contextual-add", - "platform/features/async-client", - "platform/features/graph-memory", - "platform/features/advanced-retrieval", - "platform/features/criteria-retrieval", - "platform/features/multimodal-support", - "platform/features/selective-memory", - "platform/features/custom-categories", - "platform/features/custom-instructions", - "platform/features/direct-import", - "platform/features/memory-export", - "platform/features/timestamp", - "platform/features/expiration-date", - "platform/features/webhooks", - "platform/features/feedback-mechanism", - "platform/features/group-chat" - ] - } - ] - }, - { - "group": "Open Source", - "icon": "code-branch", - "pages": [ - "open-source/overview", - "open-source/python-quickstart", - "open-source/node-quickstart", - { - "group": "Features", - "icon": "star", - "pages": [ - "open-source/features/overview", - "open-source/features/async-memory", - "open-source/features/openai_compatibility", - "open-source/features/custom-fact-extraction-prompt", - "open-source/features/custom-update-memory-prompt", - "open-source/features/multimodal-support", - "open-source/features/rest-api", - "open-source/features/metadata-filtering", - "open-source/features/reranker-search" - ] - }, - { - "group": "Graph Memory", - "icon": "spider-web", - "pages": [ - "open-source/graph_memory/overview", - "open-source/graph_memory/features" - ] - }, - { - "group": "LLMs", - "icon": "brain", - "pages": [ - "components/llms/overview", - "components/llms/config", - { - "group": "Supported LLMs", - "icon": "list", - "pages": [ - "components/llms/models/openai", - "components/llms/models/anthropic", - "components/llms/models/azure_openai", - "components/llms/models/ollama", - "components/llms/models/together", - "components/llms/models/groq", - "components/llms/models/litellm", - "components/llms/models/mistral_AI", - "components/llms/models/google_AI", - "components/llms/models/aws_bedrock", - "components/llms/models/deepseek", - "components/llms/models/xAI", - "components/llms/models/sarvam", - "components/llms/models/lmstudio", - "components/llms/models/langchain", - "components/llms/models/vllm" - ] - } - ] - }, - { - "group": "Vector Databases", - "icon": "database", - "pages": [ - "components/vectordbs/overview", - "components/vectordbs/config", - { - "group": "Supported Vector Databases", - "icon": "server", - "pages": [ - "components/vectordbs/dbs/qdrant", - "components/vectordbs/dbs/chroma", - "components/vectordbs/dbs/pgvector", - "components/vectordbs/dbs/milvus", - "components/vectordbs/dbs/pinecone", - "components/vectordbs/dbs/mongodb", - "components/vectordbs/dbs/azure", - "components/vectordbs/dbs/redis", - "components/vectordbs/dbs/valkey", - "components/vectordbs/dbs/elasticsearch", - "components/vectordbs/dbs/opensearch", - "components/vectordbs/dbs/supabase", - "components/vectordbs/dbs/upstash-vector", - "components/vectordbs/dbs/vectorize", - "components/vectordbs/dbs/vertex_ai", - "components/vectordbs/dbs/weaviate", - "components/vectordbs/dbs/faiss", - "components/vectordbs/dbs/langchain", - "components/vectordbs/dbs/baidu", - "components/vectordbs/dbs/s3_vectors", - "components/vectordbs/dbs/databricks", - "components/vectordbs/dbs/neptune_analytics" - ] - } - ] - }, - { - "group": "Embedding Models", - "icon": "layer-group", - "pages": [ - "components/embedders/overview", - "components/embedders/config", - { - "group": "Supported Embedding Models", - "icon": "list", - "pages": [ - "components/embedders/models/openai", - "components/embedders/models/azure_openai", - "components/embedders/models/ollama", - "components/embedders/models/huggingface", - "components/embedders/models/vertexai", - "components/embedders/models/google_AI", - "components/embedders/models/lmstudio", - "components/embedders/models/together", - "components/embedders/models/langchain", - "components/embedders/models/aws_bedrock" - ] - } - ] - }, - { - "group": "Rerankers (New in v1.0)", - "icon": "sort", - "pages": [ - "components/rerankers/overview", - "components/rerankers/config", - { - "group": "Supported Rerankers", - "icon": "list", - "pages": [ - "components/rerankers/models/cohere", - "components/rerankers/models/sentence_transformer", - "components/rerankers/models/huggingface", - "components/rerankers/models/llm_reranker" - ] - } - ] - } - ] - }, - { - "group": "Migration Guide", - "icon": "arrow-right", - "pages": [ - "migration/v0-to-v1", - "migration/breaking-changes", - "migration/api-changes" - ] - }, - { - "group": "OpenMemory", - "icon": "square-terminal", - "pages": [ - "openmemory/overview", - "openmemory/quickstart", - "openmemory/integrations" - ] - }, - { - "group": "Contribution", - "icon": "handshake", - "pages": [ - "contributing/development", - "contributing/documentation" - ] - } - ] - }, - { - "tab": "Examples", - "groups": [ - { - "group": "💡 Examples", - "icon": "lightbulb", - "pages": [ - "examples", - "examples/aws_example", - "examples/aws_neptune_analytics_hybrid_store", - "examples/mem0-demo", - "examples/ai_companion_js", - "examples/collaborative-task-agent", - "examples/llamaindex-multiagent-learning-system", - "examples/personalized-search-tavily-mem0", - "examples/eliza_os", - "examples/mem0-mastra", - "examples/mem0-with-ollama", - "examples/personal-ai-tutor", - "examples/customer-support-agent", - "examples/personal-travel-assistant", - "examples/llama-index-mem0", - "examples/chrome-extension", - "examples/memory-guided-content-writing", - "examples/multimodal-demo", - "examples/personalized-deep-research", - "examples/mem0-agentic-tool", - "examples/openai-inbuilt-tools", - "examples/mem0-openai-voice-demo", - "examples/mem0-google-adk-healthcare-assistant", - "examples/email_processing", - "examples/youtube-assistant" - ] - } - ] - }, - { - "tab": "Integrations", - "groups": [ - { - "group": "Integrations", - "icon": "plug", - "pages": [ - "integrations", - "integrations/langchain", - "integrations/langgraph", - "integrations/llama-index", - "integrations/agno", - "integrations/autogen", - "integrations/crewai", - "integrations/openai-agents-sdk", - "integrations/google-ai-adk", - "integrations/mastra", - "integrations/vercel-ai-sdk", - "integrations/livekit", - "integrations/pipecat", - "integrations/elevenlabs", - "integrations/aws-bedrock", - "integrations/flowise", - "integrations/langchain-tools", - "integrations/agentops", - "integrations/keywords", - "integrations/dify", - "integrations/raycast" - ] - } - ] - }, - { - "tab": "API Reference", - "icon": "square-terminal", - "groups": [ - { - "group": "API Reference", - "icon": "terminal", - "pages": [ - "api-reference", - { - "group": "Memory APIs", - "icon": "microchip", - "pages": [ - "api-reference/memory/add-memories", - "api-reference/memory/v2-search-memories", - "api-reference/memory/v2-get-memories", - "api-reference/memory/history-memory", - "api-reference/memory/get-memory", - "api-reference/memory/update-memory", - "api-reference/memory/batch-update", - "api-reference/memory/delete-memory", - "api-reference/memory/batch-delete", - "api-reference/memory/delete-memories", - "api-reference/memory/create-memory-export", - "api-reference/memory/get-memory-export", - "api-reference/memory/feedback" - ] - }, - { - "group": "Entities APIs", - "icon": "users", - "pages": [ - "api-reference/entities/get-users", - "api-reference/entities/delete-user" - ] - }, - { - "group": "Organizations APIs", - "icon": "building", - "pages": [ - "api-reference/organization/create-org", - "api-reference/organization/get-orgs", - "api-reference/organization/get-org", - "api-reference/organization/get-org-members", - "api-reference/organization/add-org-member", - "api-reference/organization/delete-org" - ] - }, - { - "group": "Project APIs", - "icon": "folder", - "pages": [ - "api-reference/project/create-project", - "api-reference/project/get-projects", - "api-reference/project/get-project", - "api-reference/project/get-project-members", - "api-reference/project/add-project-member", - "api-reference/project/delete-project" - ] - }, - { - "group": "Webhook APIs", - "icon": "webhook", - "pages": [ - "api-reference/webhook/create-webhook", - "api-reference/webhook/get-webhook", - "api-reference/webhook/update-webhook", - "api-reference/webhook/delete-webhook" - ] - } - ] - } - ] - }, - { - "tab": "Changelog", - "icon": "clock", - "groups": [ - { - "group": "Product Updates", - "icon": "rocket", - "pages": [ - "changelog" - ] - } - ] - } - ] - } - ] - }, - { - "version": "v0.x Legacy", - "anchors": [ - { - "anchor": "Documentation", - "icon": "book-open", - "tabs": [ - { - "tab": "Documentation", - "groups": [ - { - "group": "Getting Started", - "icon": "rocket", - "pages": [ - "v0x/introduction", - "v0x/quickstart", - "v0x/faqs" - ] - }, - { - "group": "Core Concepts", - "icon": "brain", - "pages": [ - "v0x/core-concepts/memory-types", - { - "group": "Memory Operations", - "icon": "gear", - "pages": [ - "v0x/core-concepts/memory-operations/add", - "v0x/core-concepts/memory-operations/search", - "v0x/core-concepts/memory-operations/update", - "v0x/core-concepts/memory-operations/delete" - ] - } - ] - }, - { - "group": "Open Source", - "icon": "code-branch", - "pages": [ - "v0x/open-source/overview", - "v0x/open-source/python-quickstart", - "v0x/open-source/node-quickstart", - { - "group": "LLMs", - "icon": "brain", - "pages": [ - "v0x/components/llms/overview", - "v0x/components/llms/config", - { - "group": "Supported LLMs", - "icon": "list", - "pages": [ - "v0x/components/llms/models/openai", - "v0x/components/llms/models/anthropic", - "v0x/components/llms/models/azure_openai", - "v0x/components/llms/models/ollama", - "v0x/components/llms/models/together", - "v0x/components/llms/models/groq", - "v0x/components/llms/models/litellm", - "v0x/components/llms/models/mistral_AI", - "v0x/components/llms/models/google_AI", - "v0x/components/llms/models/aws_bedrock", - "v0x/components/llms/models/deepseek", - "v0x/components/llms/models/xAI", - "v0x/components/llms/models/sarvam", - "v0x/components/llms/models/lmstudio", - "v0x/components/llms/models/langchain", - "v0x/components/llms/models/vllm" - ] - } - ] - }, - { - "group": "Vector Databases", - "icon": "database", - "pages": [ - "v0x/components/vectordbs/overview", - "v0x/components/vectordbs/config", - { - "group": "Supported Vector Databases", - "icon": "server", - "pages": [ - "v0x/components/vectordbs/dbs/qdrant", - "v0x/components/vectordbs/dbs/chroma", - "v0x/components/vectordbs/dbs/pgvector", - "v0x/components/vectordbs/dbs/milvus", - "v0x/components/vectordbs/dbs/pinecone", - "v0x/components/vectordbs/dbs/mongodb", - "v0x/components/vectordbs/dbs/azure", - "v0x/components/vectordbs/dbs/redis", - "v0x/components/vectordbs/dbs/valkey", - "v0x/components/vectordbs/dbs/elasticsearch", - "v0x/components/vectordbs/dbs/opensearch", - "v0x/components/vectordbs/dbs/supabase", - "v0x/components/vectordbs/dbs/upstash-vector", - "v0x/components/vectordbs/dbs/vectorize", - "v0x/components/vectordbs/dbs/vertex_ai", - "v0x/components/vectordbs/dbs/weaviate", - "v0x/components/vectordbs/dbs/faiss", - "v0x/components/vectordbs/dbs/langchain", - "v0x/components/vectordbs/dbs/baidu", - "v0x/components/vectordbs/dbs/s3_vectors", - "v0x/components/vectordbs/dbs/databricks", - "v0x/components/vectordbs/dbs/neptune_analytics" - ] - } - ] - }, - { - "group": "Embedding Models", - "icon": "layer-group", - "pages": [ - "v0x/components/embedders/overview", - "v0x/components/embedders/config", - { - "group": "Supported Embedding Models", - "icon": "list", - "pages": [ - "v0x/components/embedders/models/openai", - "v0x/components/embedders/models/azure_openai", - "v0x/components/embedders/models/ollama", - "v0x/components/embedders/models/huggingface", - "v0x/components/embedders/models/vertexai", - "v0x/components/embedders/models/google_AI", - "v0x/components/embedders/models/lmstudio", - "v0x/components/embedders/models/together", - "v0x/components/embedders/models/langchain", - "v0x/components/embedders/models/aws_bedrock" - ] - } - ] - } - ] - } - ] - }, - { - "tab": "Examples", - "groups": [ - { - "group": "💡 Examples", - "icon": "lightbulb", - "pages": [ - "v0x/examples/aws_example", - "v0x/examples/aws_neptune_analytics_hybrid_store", - "v0x/examples/mem0-demo", - "v0x/examples/ai_companion_js", - "v0x/examples/collaborative-task-agent", - "v0x/examples/llamaindex-multiagent-learning-system", - "v0x/examples/personalized-search-tavily-mem0", - "v0x/examples/eliza_os", - "v0x/examples/mem0-mastra", - "v0x/examples/mem0-with-ollama", - "v0x/examples/personal-ai-tutor", - "v0x/examples/customer-support-agent", - "v0x/examples/personal-travel-assistant", - "v0x/examples/llama-index-mem0", - "v0x/examples/chrome-extension", - "v0x/examples/memory-guided-content-writing", - "v0x/examples/multimodal-demo", - "v0x/examples/personalized-deep-research", - "v0x/examples/mem0-agentic-tool", - "v0x/examples/openai-inbuilt-tools", - "v0x/examples/mem0-openai-voice-demo", - "v0x/examples/mem0-google-adk-healthcare-assistant", - "v0x/examples/email_processing", - "v0x/examples/youtube-assistant" - ] - } - ] - }, - { - "tab": "Integrations", - "groups": [ - { - "group": "Integrations", - "icon": "plug", - "pages": [ - "v0x/integrations/langchain", - "v0x/integrations/langgraph", - "v0x/integrations/llama-index", - "v0x/integrations/agno", - "v0x/integrations/autogen", - "v0x/integrations/crewai", - "v0x/integrations/openai-agents-sdk", - "v0x/integrations/google-ai-adk", - "v0x/integrations/mastra", - "v0x/integrations/vercel-ai-sdk", - "v0x/integrations/livekit", - "v0x/integrations/pipecat", - "v0x/integrations/elevenlabs", - "v0x/integrations/aws-bedrock", - "v0x/integrations/flowise", - "v0x/integrations/langchain-tools", - "v0x/integrations/agentops", - "v0x/integrations/keywords", - "v0x/integrations/dify", - "v0x/integrations/raycast" - ] - } - ] - } - ] - } - ] - } - ] - }, - "logo": { - "light": "/logo/light.svg", - "dark": "/logo/dark.svg", - "href": "https://github.com/mem0ai/mem0" - }, - "background": { - "color": { - "light": "#fff", - "dark": "#09090b" - } - }, - "navbar": { - "primary": { - "type": "button", - "label": "Your Dashboard", - "href": "https://app.mem0.ai" - } - }, - "footer": { - "socials": { - "discord": "https://mem0.dev/DiD", - "x": "https://x.com/mem0ai", - "github": "https://github.com/mem0ai", - "linkedin": "https://www.linkedin.com/company/mem0/" - } - }, - "integrations": { - "posthog": { - "apiKey": "phc_hgJkUVJFYtmaJqrvf6CYN67TIQ8yhXAkWzUn9AMU4yX", - "apiHost": "https://mango.mem0.ai" - }, - "intercom": { - "appId": "jjv2r0tt" - } - } + "$schema": "https://mintlify.com/docs.json", + "name": "Mem0", + "description": "Mem0 is a self-improving memory layer for LLM applications, enabling personalized AI experiences that save costs and delight users.", + "theme": "aspen", + "colors": { + "primary": "#2553eb", + "light": "#6084fa", + "dark": "#2553eb" + }, + "favicon": "/logo/favicon.png", + "navigation": { + "versions": [ + { + "version": "v1.0.0 Beta", + "anchors": [ + { + "anchor": "Documentation", + "icon": "book-open", + "tabs": [ + { + "tab": "Documentation", + "groups": [ + { + "group": "Getting Started", + "icon": "rocket", + "pages": [ + "introduction", + "quickstart", + "faqs" + ] + }, + { + "group": "Core Concepts", + "icon": "brain", + "pages": [ + "core-concepts/memory-types", + { + "group": "Memory Operations", + "icon": "gear", + "pages": [ + "core-concepts/memory-operations/add", + "core-concepts/memory-operations/search", + "core-concepts/memory-operations/update", + "core-concepts/memory-operations/delete" + ] + } + ] + }, + { + "group": "Platform", + "icon": "globe", + "pages": [ + "platform/overview", + "platform/quickstart", + "platform/advanced-memory-operations", + { + "group": "Features", + "icon": "star", + "pages": [ + "platform/features/platform-overview", + "platform/features/contextual-add", + "platform/features/async-client", + "platform/features/graph-memory", + "platform/features/advanced-retrieval", + "platform/features/criteria-retrieval", + "platform/features/multimodal-support", + "platform/features/selective-memory", + "platform/features/custom-categories", + "platform/features/custom-instructions", + "platform/features/direct-import", + "platform/features/memory-export", + "platform/features/timestamp", + "platform/features/expiration-date", + "platform/features/webhooks", + "platform/features/feedback-mechanism", + "platform/features/group-chat" + ] + } + ] + }, + { + "group": "Open Source", + "icon": "code-branch", + "pages": [ + "open-source/overview", + "open-source/python-quickstart", + "open-source/node-quickstart", + { + "group": "Features", + "icon": "star", + "pages": [ + "open-source/features/overview", + "open-source/features/async-memory", + "open-source/features/openai_compatibility", + "open-source/features/custom-fact-extraction-prompt", + "open-source/features/custom-update-memory-prompt", + "open-source/features/multimodal-support", + "open-source/features/rest-api", + "open-source/features/metadata-filtering", + "open-source/features/reranker-search" + ] + }, + { + "group": "Graph Memory", + "icon": "spider-web", + "pages": [ + "open-source/graph_memory/overview", + "open-source/graph_memory/features" + ] + }, + { + "group": "LLMs", + "icon": "brain", + "pages": [ + "components/llms/overview", + "components/llms/config", + { + "group": "Supported LLMs", + "icon": "list", + "pages": [ + "components/llms/models/openai", + "components/llms/models/anthropic", + "components/llms/models/azure_openai", + "components/llms/models/ollama", + "components/llms/models/together", + "components/llms/models/groq", + "components/llms/models/litellm", + "components/llms/models/mistral_AI", + "components/llms/models/google_AI", + "components/llms/models/aws_bedrock", + "components/llms/models/deepseek", + "components/llms/models/xAI", + "components/llms/models/sarvam", + "components/llms/models/lmstudio", + "components/llms/models/langchain", + "components/llms/models/vllm" + ] + } + ] + }, + { + "group": "Vector Databases", + "icon": "database", + "pages": [ + "components/vectordbs/overview", + "components/vectordbs/config", + { + "group": "Supported Vector Databases", + "icon": "server", + "pages": [ + "components/vectordbs/dbs/qdrant", + "components/vectordbs/dbs/chroma", + "components/vectordbs/dbs/pgvector", + "components/vectordbs/dbs/milvus", + "components/vectordbs/dbs/pinecone", + "components/vectordbs/dbs/mongodb", + "components/vectordbs/dbs/azure", + "components/vectordbs/dbs/redis", + "components/vectordbs/dbs/valkey", + "components/vectordbs/dbs/elasticsearch", + "components/vectordbs/dbs/opensearch", + "components/vectordbs/dbs/supabase", + "components/vectordbs/dbs/upstash-vector", + "components/vectordbs/dbs/vectorize", + "components/vectordbs/dbs/vertex_ai", + "components/vectordbs/dbs/weaviate", + "components/vectordbs/dbs/faiss", + "components/vectordbs/dbs/langchain", + "components/vectordbs/dbs/baidu", + "components/vectordbs/dbs/s3_vectors", + "components/vectordbs/dbs/databricks", + "components/vectordbs/dbs/neptune_analytics" + ] + } + ] + }, + { + "group": "Embedding Models", + "icon": "layer-group", + "pages": [ + "components/embedders/overview", + "components/embedders/config", + { + "group": "Supported Embedding Models", + "icon": "list", + "pages": [ + "components/embedders/models/openai", + "components/embedders/models/azure_openai", + "components/embedders/models/ollama", + "components/embedders/models/huggingface", + "components/embedders/models/vertexai", + "components/embedders/models/google_AI", + "components/embedders/models/lmstudio", + "components/embedders/models/together", + "components/embedders/models/langchain", + "components/embedders/models/aws_bedrock" + ] + } + ] + }, + { + "group": "Rerankers (New in v1.0)", + "icon": "sort", + "pages": [ + "components/rerankers/overview", + "components/rerankers/config", + { + "group": "Supported Rerankers", + "icon": "list", + "pages": [ + "components/rerankers/models/cohere", + "components/rerankers/models/sentence_transformer", + "components/rerankers/models/huggingface", + "components/rerankers/models/llm_reranker" + ] + } + ] + } + ] + }, + { + "group": "Migration Guide", + "icon": "arrow-right", + "pages": [ + "migration/v0-to-v1", + "migration/breaking-changes", + "migration/api-changes" + ] + }, + { + "group": "OpenMemory", + "icon": "square-terminal", + "pages": [ + "openmemory/overview", + "openmemory/quickstart", + "openmemory/integrations" + ] + }, + { + "group": "Contribution", + "icon": "handshake", + "pages": [ + "contributing/development", + "contributing/documentation" + ] + } + ] + }, + { + "tab": "Examples", + "groups": [ + { + "group": "\ud83d\udca1 Examples", + "icon": "lightbulb", + "pages": [ + "examples", + "examples/mem0-demo", + "examples/ai_companion_js", + "examples/mem0-with-ollama", + "examples/personal-ai-tutor", + "examples/customer-support-agent", + "examples/personal-travel-assistant", + "examples/chrome-extension", + "examples/youtube-assistant", + "examples/memory-guided-content-writing", + "examples/multimodal-demo", + "examples/email_processing", + "examples/personalized-deep-research", + "examples/collaborative-task-agent", + "examples/llama-index-mem0", + "examples/llamaindex-multiagent-learning-system", + "examples/personalized-search-tavily-mem0", + "examples/mem0-agentic-tool", + "examples/openai-inbuilt-tools", + "examples/mem0-openai-voice-demo", + "examples/mem0-google-adk-healthcare-assistant", + "examples/mem0-mastra", + "examples/eliza_os", + "examples/aws_example", + "examples/aws_neptune_analytics_hybrid_store" + ] + } + ] + }, + { + "tab": "Integrations", + "groups": [ + { + "group": "Integrations", + "icon": "plug", + "pages": [ + "integrations", + "integrations/langchain", + "integrations/langgraph", + "integrations/llama-index", + "integrations/agno", + "integrations/autogen", + "integrations/crewai", + "integrations/openai-agents-sdk", + "integrations/google-ai-adk", + "integrations/mastra", + "integrations/vercel-ai-sdk", + "integrations/livekit", + "integrations/pipecat", + "integrations/elevenlabs", + "integrations/aws-bedrock", + "integrations/flowise", + "integrations/langchain-tools", + "integrations/agentops", + "integrations/keywords", + "integrations/dify", + "integrations/raycast" + ] + } + ] + }, + { + "tab": "API Reference", + "icon": "square-terminal", + "groups": [ + { + "group": "API Reference", + "icon": "terminal", + "pages": [ + "api-reference", + { + "group": "Memory APIs", + "icon": "microchip", + "pages": [ + "api-reference/memory/add-memories", + "api-reference/memory/v2-search-memories", + "api-reference/memory/v2-get-memories", + "api-reference/memory/history-memory", + "api-reference/memory/get-memory", + "api-reference/memory/update-memory", + "api-reference/memory/batch-update", + "api-reference/memory/delete-memory", + "api-reference/memory/batch-delete", + "api-reference/memory/delete-memories", + "api-reference/memory/create-memory-export", + "api-reference/memory/get-memory-export", + "api-reference/memory/feedback" + ] + }, + { + "group": "Entities APIs", + "icon": "users", + "pages": [ + "api-reference/entities/get-users", + "api-reference/entities/delete-user" + ] + }, + { + "group": "Organizations APIs", + "icon": "building", + "pages": [ + "api-reference/organization/create-org", + "api-reference/organization/get-orgs", + "api-reference/organization/get-org", + "api-reference/organization/get-org-members", + "api-reference/organization/add-org-member", + "api-reference/organization/delete-org" + ] + }, + { + "group": "Project APIs", + "icon": "folder", + "pages": [ + "api-reference/project/create-project", + "api-reference/project/get-projects", + "api-reference/project/get-project", + "api-reference/project/get-project-members", + "api-reference/project/add-project-member", + "api-reference/project/delete-project" + ] + }, + { + "group": "Webhook APIs", + "icon": "webhook", + "pages": [ + "api-reference/webhook/create-webhook", + "api-reference/webhook/get-webhook", + "api-reference/webhook/update-webhook", + "api-reference/webhook/delete-webhook" + ] + } + ] + } + ] + }, + { + "tab": "Changelog", + "icon": "clock", + "groups": [ + { + "group": "Product Updates", + "icon": "rocket", + "pages": [ + "changelog" + ] + } + ] + } + ] + } + ] + }, + { + "version": "v0.x Legacy", + "anchors": [ + { + "anchor": "Documentation", + "icon": "book-open", + "tabs": [ + { + "tab": "Documentation", + "groups": [ + { + "group": "Getting Started", + "icon": "rocket", + "pages": [ + "v0x/introduction", + "v0x/quickstart", + "v0x/faqs" + ] + }, + { + "group": "Core Concepts", + "icon": "brain", + "pages": [ + "v0x/core-concepts/memory-types", + { + "group": "Memory Operations", + "icon": "gear", + "pages": [ + "v0x/core-concepts/memory-operations/add", + "v0x/core-concepts/memory-operations/search", + "v0x/core-concepts/memory-operations/update", + "v0x/core-concepts/memory-operations/delete" + ] + } + ] + }, + { + "group": "Open Source", + "icon": "code-branch", + "pages": [ + "v0x/open-source/overview", + "v0x/open-source/python-quickstart", + "v0x/open-source/node-quickstart", + { + "group": "LLMs", + "icon": "brain", + "pages": [ + "v0x/components/llms/overview", + "v0x/components/llms/config", + { + "group": "Supported LLMs", + "icon": "list", + "pages": [ + "v0x/components/llms/models/openai", + "v0x/components/llms/models/anthropic", + "v0x/components/llms/models/azure_openai", + "v0x/components/llms/models/ollama", + "v0x/components/llms/models/together", + "v0x/components/llms/models/groq", + "v0x/components/llms/models/litellm", + "v0x/components/llms/models/mistral_AI", + "v0x/components/llms/models/google_AI", + "v0x/components/llms/models/aws_bedrock", + "v0x/components/llms/models/deepseek", + "v0x/components/llms/models/xAI", + "v0x/components/llms/models/sarvam", + "v0x/components/llms/models/lmstudio", + "v0x/components/llms/models/langchain", + "v0x/components/llms/models/vllm" + ] + } + ] + }, + { + "group": "Vector Databases", + "icon": "database", + "pages": [ + "v0x/components/vectordbs/overview", + "v0x/components/vectordbs/config", + { + "group": "Supported Vector Databases", + "icon": "server", + "pages": [ + "v0x/components/vectordbs/dbs/qdrant", + "v0x/components/vectordbs/dbs/chroma", + "v0x/components/vectordbs/dbs/pgvector", + "v0x/components/vectordbs/dbs/milvus", + "v0x/components/vectordbs/dbs/pinecone", + "v0x/components/vectordbs/dbs/mongodb", + "v0x/components/vectordbs/dbs/azure", + "v0x/components/vectordbs/dbs/redis", + "v0x/components/vectordbs/dbs/valkey", + "v0x/components/vectordbs/dbs/elasticsearch", + "v0x/components/vectordbs/dbs/opensearch", + "v0x/components/vectordbs/dbs/supabase", + "v0x/components/vectordbs/dbs/upstash-vector", + "v0x/components/vectordbs/dbs/vectorize", + "v0x/components/vectordbs/dbs/vertex_ai", + "v0x/components/vectordbs/dbs/weaviate", + "v0x/components/vectordbs/dbs/faiss", + "v0x/components/vectordbs/dbs/langchain", + "v0x/components/vectordbs/dbs/baidu", + "v0x/components/vectordbs/dbs/s3_vectors", + "v0x/components/vectordbs/dbs/databricks", + "v0x/components/vectordbs/dbs/neptune_analytics" + ] + } + ] + }, + { + "group": "Embedding Models", + "icon": "layer-group", + "pages": [ + "v0x/components/embedders/overview", + "v0x/components/embedders/config", + { + "group": "Supported Embedding Models", + "icon": "list", + "pages": [ + "v0x/components/embedders/models/openai", + "v0x/components/embedders/models/azure_openai", + "v0x/components/embedders/models/ollama", + "v0x/components/embedders/models/huggingface", + "v0x/components/embedders/models/vertexai", + "v0x/components/embedders/models/google_AI", + "v0x/components/embedders/models/lmstudio", + "v0x/components/embedders/models/together", + "v0x/components/embedders/models/langchain", + "v0x/components/embedders/models/aws_bedrock" + ] + } + ] + } + ] + } + ] + }, + { + "tab": "Examples", + "groups": [ + { + "group": "\ud83d\udca1 Examples", + "icon": "lightbulb", + "pages": [ + "examples", + "v0x/examples/mem0-demo", + "v0x/examples/ai_companion_js", + "v0x/examples/mem0-with-ollama", + "v0x/examples/personal-ai-tutor", + "v0x/examples/customer-support-agent", + "v0x/examples/personal-travel-assistant", + "v0x/examples/chrome-extension", + "v0x/examples/youtube-assistant", + "v0x/examples/memory-guided-content-writing", + "v0x/examples/multimodal-demo", + "v0x/examples/email_processing", + "v0x/examples/personalized-deep-research", + "v0x/examples/collaborative-task-agent", + "v0x/examples/llama-index-mem0", + "v0x/examples/llamaindex-multiagent-learning-system", + "v0x/examples/personalized-search-tavily-mem0", + "v0x/examples/mem0-agentic-tool", + "v0x/examples/openai-inbuilt-tools", + "v0x/examples/mem0-openai-voice-demo", + "v0x/examples/mem0-google-adk-healthcare-assistant", + "v0x/examples/mem0-mastra", + "v0x/examples/eliza_os", + "v0x/examples/aws_example", + "v0x/examples/aws_neptune_analytics_hybrid_store" + ] + } + ] + }, + { + "tab": "Integrations", + "groups": [ + { + "group": "Integrations", + "icon": "plug", + "pages": [ + "v0x/integrations/langchain", + "v0x/integrations/langgraph", + "v0x/integrations/llama-index", + "v0x/integrations/agno", + "v0x/integrations/autogen", + "v0x/integrations/crewai", + "v0x/integrations/openai-agents-sdk", + "v0x/integrations/google-ai-adk", + "v0x/integrations/mastra", + "v0x/integrations/vercel-ai-sdk", + "v0x/integrations/livekit", + "v0x/integrations/pipecat", + "v0x/integrations/elevenlabs", + "v0x/integrations/aws-bedrock", + "v0x/integrations/flowise", + "v0x/integrations/langchain-tools", + "v0x/integrations/agentops", + "v0x/integrations/keywords", + "v0x/integrations/dify", + "v0x/integrations/raycast" + ] + } + ] + } + ] + } + ] + } + ] + }, + "logo": { + "light": "/logo/light.svg", + "dark": "/logo/dark.svg", + "href": "https://github.com/mem0ai/mem0" + }, + "background": { + "color": { + "light": "#fff", + "dark": "#09090b" + } + }, + "navbar": { + "primary": { + "type": "button", + "label": "Your Dashboard", + "href": "https://app.mem0.ai" + } + }, + "footer": { + "socials": { + "discord": "https://mem0.dev/DiD", + "x": "https://x.com/mem0ai", + "github": "https://github.com/mem0ai", + "linkedin": "https://www.linkedin.com/company/mem0/" + } + }, + "integrations": { + "posthog": { + "apiKey": "phc_hgJkUVJFYtmaJqrvf6CYN67TIQ8yhXAkWzUn9AMU4yX", + "apiHost": "https://mango.mem0.ai" + }, + "intercom": { + "appId": "jjv2r0tt" + } + } } \ No newline at end of file diff --git a/docs/examples.mdx b/docs/examples.mdx index 1b95f8e45..27ac459d4 100644 --- a/docs/examples.mdx +++ b/docs/examples.mdx @@ -18,71 +18,99 @@ Here are some examples of how Mem0 can be integrated into various applications: Explore how **Mem0** can power real-world applications and bring personalized, intelligent experiences to life: + + Get started with **Mem0** with this simple demo showcasing basic memory operations. + + - Build a personalized AI Companion in **Node.js** that remembers conversations and adapts over time using Mem0. + Build a personalized AI Companion in **Node.js** that remembers conversations and adapts over time. - Run **Mem0 locally** with **Ollama** to create private, stateful AI experiences without relying on cloud APIs. + Run **Mem0 locally** with **Ollama** to create private, stateful AI experiences without cloud APIs. - Create an **AI Tutor** that adapts to student progress, learning style, and history — for a truly customized learning experience. - - - - Develop a **Personal Travel Assistant** that remembers your preferences, past trips, and helps plan future adventures. + Create an **AI Tutor** that adapts to student progress, learning style, and history. - Build a **Customer Support AI** that recalls user preferences, past chats, and provides context-aware, efficient help. + Build a **Customer Support AI** that recalls user preferences and past chats. - - Combine **LlamaIndex** and Mem0 to create a powerful **ReAct Agent** with persistent memory for smarter interactions. - - - - Multi-agent learning system powered by memory. + + Develop a **Personal Travel Assistant** that remembers your preferences and past trips. - Add **long-term memory** to ChatGPT, Claude, or Perplexity via the **Mem0 Chrome Extension** — personalize your AI chats anywhere. + Add **long-term memory** to ChatGPT, Claude, or Perplexity via the **Mem0 Chrome Extension**. - - Integrate **Mem0** into **YouTube's** native UI, providing personalized responses with video context. - + + Integrate **Mem0** into **YouTube's** native UI with personalized responses. + - Create a **Writing Assistant** that understands and adapts to your unique style, improving consistency and productivity. + Create a **Writing Assistant** that understands and adapts to your unique style. - Supercharge AI with **Mem0's multimodal memory** — blend text, images, and more for richer, context-aware interactions. - - - - Build a **Deep Research AI** that remembers your research goals and compiles insights from vast information sources. - - - - Integrate Mem0's memory capabilities with OpenAI's Agents SDK to create AI agents with persistent memory. - - - - Use Mem0's memory capabilities with OpenAI's Inbuilt Tools to create AI agents with persistent memory. - - - - Use Mem0's memory capabilities with OpenAI's Inbuilt Tools to create AI agents with persistent memory. - - - - Build a personalized healthcare assistant with persistent memory using Google's ADK and Mem0. + Supercharge AI with **Mem0's multimodal memory** — blend text, images, and more. - Use Mem0's memory capabilities to process emails and create AI agents with persistent memory. + Use Mem0's memory capabilities to process emails with persistent memory. + + + + Build a **Deep Research AI** that remembers your research goals. + + + + Build collaborative agents with shared memory across multiple users. + + + + Combine **LlamaIndex** and Mem0 to create a **ReAct Agent** with persistent memory. + + + + Multi-agent learning system powered by memory. + + + + Build a personalized search experience using Mem0 and Tavily. + + + + Integrate Mem0's memory capabilities with OpenAI's Agents SDK. + + + + Use Mem0 with OpenAI's Inbuilt Tools to create AI agents with persistent memory. + + + + Voice-enabled AI agents with persistent memory using OpenAI. + + + + Build a personalized healthcare assistant with persistent memory using Google ADK. + + + + Integrate Mem0 with Mastra for powerful agentic workflows. + + + + Build conversational AI characters with persistent memory using Eliza OS. + + + + Use Mem0 with **AWS Bedrock**, **OpenSearch**, and **Neptune Analytics**. + + + + Hybrid memory store with **AWS Neptune Analytics** and Bedrock. diff --git a/docs/examples/aws_example.mdx b/docs/examples/aws_example.mdx index 0766937fd..33c4b9fe7 100644 --- a/docs/examples/aws_example.mdx +++ b/docs/examples/aws_example.mdx @@ -1,5 +1,5 @@ --- -title: "AWS bedrock, OpenSearch and Neptune Analytics" +title: "AWS Bedrock Example" --- This example demonstrates how to configure and use the `mem0ai` SDK with **AWS Bedrock**, **OpenSearch Service (AOSS)**, and **AWS Neptune Analytics** for persistent memory capabilities in Python. diff --git a/docs/examples/aws_neptune_analytics_hybrid_store.mdx b/docs/examples/aws_neptune_analytics_hybrid_store.mdx index b3c54bcb5..c1fba21db 100644 --- a/docs/examples/aws_neptune_analytics_hybrid_store.mdx +++ b/docs/examples/aws_neptune_analytics_hybrid_store.mdx @@ -1,5 +1,5 @@ --- -title: "Neptune Analytics Hybrid Store" +title: "AWS Neptune Analytics" --- This example demonstrates how to configure and use the `mem0ai` SDK with **AWS Bedrock** and **AWS Neptune Analytics** for persistent memory capabilities in Python. diff --git a/docs/examples/personalized-search-tavily-mem0.mdx b/docs/examples/personalized-search-tavily-mem0.mdx index 895f4d446..41e5382bc 100644 --- a/docs/examples/personalized-search-tavily-mem0.mdx +++ b/docs/examples/personalized-search-tavily-mem0.mdx @@ -1,5 +1,5 @@ --- -title: 'Personalized Search with Mem0 and Tavily' +title: 'Personalized Search with Tavily' --- diff --git a/docs/integrations/google-ai-adk.mdx b/docs/integrations/google-ai-adk.mdx index a7a5ff52d..3508d61c6 100644 --- a/docs/integrations/google-ai-adk.mdx +++ b/docs/integrations/google-ai-adk.mdx @@ -1,8 +1,8 @@ --- -title: Google Agent Development Kit +title: Google ADK --- -Integrate [**Mem0**](https://github.com/mem0ai/mem0) with [Google Agent Development Kit (ADK)](https://github.com/google/adk-python), an open-source framework for building multi-agent workflows. This integration enables agents to access persistent memory across conversations, enhancing context retention and personalization. +Integrate [**Mem0**](https://github.com/mem0ai/mem0) with [Google ADK (Agent Development Kit)](https://github.com/google/adk-python), an open-source framework for building multi-agent workflows. This integration enables agents to access persistent memory across conversations, enhancing context retention and personalization. ## Overview diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 4f996c1e8..81640dbbb 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -4,6 +4,10 @@ icon: "book" iconType: "solid" --- + +**Mem0 v1.0.0 Beta is here!** Check out our [research paper](https://mem0.ai/research) to learn about the technical foundations and innovations behind Mem0's memory architecture. + + Mem0 is a memory layer designed for modern AI agents. It acts as a persistent memory layer that agents can use to: - Recall relevant past interactions diff --git a/docs/openapi.json b/docs/openapi.json index 530c7a0eb..75b81d25e 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -329,7 +329,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/v1/entities/{entity_type}/{entity_id}/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/v1/entities/{entity_type}/{entity_id}/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -1100,137 +1100,16 @@ ], "description": "Get all memories.", "operationId": "memories_list_v2", - "parameters": [ - { - "name": "filters", - "in": "query", - "schema": { - "type": "object", - "properties": { - "user_id": { - "type": "string" - }, - "agent_id": { - "type": "string" - }, - "app_id": { - "type": "string" - }, - "run_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "categories": { - "type": "object", - "properties": { - "in": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "metadata": { - "type": "object" - }, - "keywords": { - "type": "object", - "properties": { - "contains": { - "type": "string" - }, - "icontains": { - "type": "string" - } - } - } - }, - "additionalProperties": { - "type": "object", - "properties": { - "in": { - "type": "array" - }, - "gte": { - "type": "string" - }, - "lte": { - "type": "string" - }, - "gt": { - "type": "string" - }, - "lt": { - "type": "string" - }, - "ne": { - "type": "string" - }, - "contains": { - "type": "string" - }, - "icontains": { - "type": "string" - } - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemoryGetInputV2" } - }, - "description": "Filters to apply to the memories. Available fields are: user_id, agent_id, app_id, run_id, created_at, updated_at, categories, keywords. Supports logical operators (AND, OR) and comparison operators (in, gte, lte, gt, lt, ne, contains, icontains). For categories field, use 'contains' for partial matching (e.g., {\"categories\": {\"contains\": \"finance\"}}) or 'in' for exact matching (e.g., {\"categories\": {\"in\": [\"personal_information\"]}}).", - "style": "deepObject", - "explode": true + } }, - { - "name": "fields", - "in": "query", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "A list of field names to include in the response. If not provided, all fields will be returned." - }, - { - "name": "org_id", - "in": "query", - "schema": { - "type": "string" - }, - "description": "Filter memories by organization ID." - }, - { - "name": "project_id", - "in": "query", - "schema": { - "type": "string" - }, - "description": "Filter memories by project ID." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Page number for pagination. Default: 1." - }, - { - "name": "page_size", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Number of items per page. Default: 100." - } - ], + "required": true + }, "responses": { "200": { "description": "Successfully retrieved memories.", @@ -2357,7 +2236,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -2454,7 +2333,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/\"\n\npayload = {\"name\": \"\"}\nheaders = {\n \"Authorization\": \"\",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/\"\n\npayload = {\"name\": \"\"}\nheaders = {\n \"Authorization\": \"Token \",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -2685,7 +2564,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -2779,7 +2658,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -2904,7 +2783,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"\",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"Token \",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -3029,7 +2908,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"\",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"Token \",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -3126,7 +3005,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\npayload = {\"email\": \"\"}\nheaders = {\n \"Authorization\": \"\",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"DELETE\", url, json=payload, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/members/\"\n\npayload = {\"email\": \"\"}\nheaders = {\n \"Authorization\": \"Token \",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"DELETE\", url, json=payload, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -3233,7 +3112,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -3352,7 +3231,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/\"\n\npayload = {\"name\": \"\"}\nheaders = {\n \"Authorization\": \"\",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/\"\n\npayload = {\"name\": \"\"}\nheaders = {\n \"Authorization\": \"Token \",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -3706,7 +3585,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -3806,7 +3685,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -3934,7 +3813,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"\",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"Token \",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"POST\", url, json=payload, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -4062,7 +3941,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"\",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\npayload = {\n \"email\": \"\",\n \"role\": \"\"\n}\nheaders = {\n \"Authorization\": \"Token \",\n \"Content-Type\": \"application/json\"\n}\n\nresponse = requests.request(\"PUT\", url, json=payload, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -4174,7 +4053,7 @@ "x-code-samples": [ { "lang": "Python", - "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\nheaders = {\"Authorization\": \"\"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" + "source": "import requests\n\nurl = \"https://api.mem0.ai/api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/\"\n\nheaders = {\"Authorization\": \"Token \"}\n\nresponse = requests.request(\"DELETE\", url, headers=headers)\n\nprint(response.text)" }, { "lang": "JavaScript", @@ -5329,6 +5208,127 @@ } } }, + "MemoryGetInputV2": { + "type": "object", + "required": [ + "filters" + ], + "properties": { + "filters": { + "title": "Filters", + "type": "object", + "description": "A dictionary of filters to apply to retrieve memories. Available fields are: user_id, agent_id, app_id, run_id, created_at, updated_at, categories, keywords. Supports logical operators (AND, OR) and comparison operators (in, gte, lte, gt, lt, ne, contains, icontains, *). For categories field, use 'contains' for partial matching (e.g., {\"categories\": {\"contains\": \"finance\"}}) or 'in' for exact matching (e.g., {\"categories\": {\"in\": [\"personal_information\"]}}).", + "properties": { + "user_id": { + "type": "string" + }, + "agent_id": { + "type": "string" + }, + "app_id": { + "type": "string" + }, + "run_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "keywords": { + "type": "object", + "properties": { + "contains": { + "type": "string" + }, + "icontains": { + "type": "string" + } + } + }, + "categories": { + "type": "object", + "properties": { + "in": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "metadata": { + "type": "object" + } + }, + "additionalProperties": { + "type": "object", + "properties": { + "in": { + "type": "array" + }, + "gte": { + "type": "string" + }, + "lte": { + "type": "string" + }, + "gt": { + "type": "string" + }, + "lt": { + "type": "string" + }, + "ne": { + "type": "string" + }, + "contains": { + "type": "string" + }, + "icontains": { + "type": "string" + } + } + } + }, + "fields": { + "title": "Fields", + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of field names to include in the response. If not provided, all fields will be returned." + }, + "page": { + "title": "Page", + "type": "integer", + "default": 1, + "description": "Page number for pagination. Default: 1" + }, + "page_size": { + "title": "Page Size", + "type": "integer", + "default": 100, + "description": "Number of items per page. Default: 100" + }, + "org_id": { + "title": "Organization id", + "type": "string", + "nullable": true, + "description": "The unique identifier of the organization associated with the memory." + }, + "project_id": { + "title": "Project id", + "type": "string", + "nullable": true, + "description": "The unique identifier of the project associated with the memory." + } + } + }, "CreateRun": { "required": [ "run_id" diff --git a/docs/v0x/examples/aws_example.mdx b/docs/v0x/examples/aws_example.mdx index 7924bf675..e8355657e 100644 --- a/docs/v0x/examples/aws_example.mdx +++ b/docs/v0x/examples/aws_example.mdx @@ -1,5 +1,5 @@ --- -title: "AWS bedrock, OpenSearch and Neptune Analytics" +title: "AWS Bedrock Example" --- This example demonstrates how to configure and use the `mem0ai` SDK with **AWS Bedrock**, **OpenSearch Service (AOSS)**, and **AWS Neptune Analytics** for persistent memory capabilities in Python. diff --git a/docs/v0x/examples/aws_neptune_analytics_hybrid_store.mdx b/docs/v0x/examples/aws_neptune_analytics_hybrid_store.mdx index b3c54bcb5..c1fba21db 100644 --- a/docs/v0x/examples/aws_neptune_analytics_hybrid_store.mdx +++ b/docs/v0x/examples/aws_neptune_analytics_hybrid_store.mdx @@ -1,5 +1,5 @@ --- -title: "Neptune Analytics Hybrid Store" +title: "AWS Neptune Analytics" --- This example demonstrates how to configure and use the `mem0ai` SDK with **AWS Bedrock** and **AWS Neptune Analytics** for persistent memory capabilities in Python. diff --git a/docs/v0x/examples/personalized-search-tavily-mem0.mdx b/docs/v0x/examples/personalized-search-tavily-mem0.mdx index d26d655ae..4c30e233d 100644 --- a/docs/v0x/examples/personalized-search-tavily-mem0.mdx +++ b/docs/v0x/examples/personalized-search-tavily-mem0.mdx @@ -1,5 +1,5 @@ --- -title: 'Personalized Search with Mem0 and Tavily' +title: 'Personalized Search with Tavily' --- diff --git a/docs/v0x/integrations/google-ai-adk.mdx b/docs/v0x/integrations/google-ai-adk.mdx index 59e317770..0374e744d 100644 --- a/docs/v0x/integrations/google-ai-adk.mdx +++ b/docs/v0x/integrations/google-ai-adk.mdx @@ -1,8 +1,8 @@ --- -title: Google Agent Development Kit +title: Google ADK --- -Integrate [**Mem0**](https://github.com/mem0ai/mem0) with [Google Agent Development Kit (ADK)](https://github.com/google/adk-python), an open-source framework for building multi-agent workflows. This integration enables agents to access persistent memory across conversations, enhancing context retention and personalization. +Integrate [**Mem0**](https://github.com/mem0ai/mem0) with [Google ADK (Agent Development Kit)](https://github.com/google/adk-python), an open-source framework for building multi-agent workflows. This integration enables agents to access persistent memory across conversations, enhancing context retention and personalization. ## Overview