Compare commits
46 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4ed150286b | |||
| 2a95c60956 | |||
| 2b0ece4b51 | |||
| 4a5e94b334 | |||
| a6c361af72 | |||
| d53ec92c1c | |||
| 3433b37e49 | |||
| fcd8ca9c07 | |||
| 7fd1d5a566 | |||
| 44d3be80f3 | |||
| 89fa87111b | |||
| 9c9cb46481 | |||
| 767812bdfc | |||
| d46c90b4ad | |||
| 3f1f80e2f5 | |||
| 98c231be39 | |||
| bd15f292e2 | |||
| 821a4d9eb3 | |||
| 78396e3245 | |||
| c54305adec | |||
| 916a1aa58f | |||
| 13bb66cdaf | |||
| d8110381b3 | |||
| 1cb1f56486 | |||
| 1f5b35f181 | |||
| fb8bba1686 | |||
| bcaaf0eaa7 | |||
| bcc2436b06 | |||
| 9a53c61f98 | |||
| f2e196c0d9 | |||
| 315df7d9d6 | |||
| 16a38382c0 | |||
| c98f467660 | |||
| 8ab0905dd2 | |||
| 36f061a46a | |||
| d7bc7e3c56 | |||
| 340803b5dc | |||
| 7a1a048def | |||
| 08d9636491 | |||
| b5ae772eae | |||
| 1943cb9d40 | |||
| a821f27baa | |||
| 79d336dac9 | |||
| 1ee9196506 | |||
| 93a4017d67 | |||
| 26520d4808 |
@@ -3,7 +3,7 @@ title: "API Reference Overview"
|
||||
sidebarTitle: "Overview"
|
||||
icon: "terminal"
|
||||
iconType: "solid"
|
||||
description: "REST APIs for memory management, search, and entity operations"
|
||||
description: "Explore the Mem0 REST API for adding, searching, updating, and deleting memories, plus managing users, organizations, projects, and webhooks."
|
||||
---
|
||||
|
||||
## Mem0 REST API
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Preview Dream Scope"
|
||||
description: "A no-write preview of the scope Dream synthesis would analyze for a project."
|
||||
openapi: "post /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/preview/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Get Dream Activity"
|
||||
description: "Supersede/merge activity feed for a project, newest first (keyset-paginated)."
|
||||
openapi: "get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/activity/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Get Dream Configuration"
|
||||
description: "Retrieve a project's Dream (memory synthesis) configuration and plan entitlements."
|
||||
openapi: "get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/config/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Get a Synthesized Memory's Sources"
|
||||
description: "The source memories a synthesized (pattern) memory was distilled from."
|
||||
openapi: "get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/memory/{memory_id}/sources/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Get Memories in a Dream Run"
|
||||
description: "Keyset page of the synthesized memories within a single synthesis run."
|
||||
openapi: "get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/runs/{run_id}/memories/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Get Dream Synthesis Runs"
|
||||
description: "Synthesis activity grouped per run, newest first (keyset-paginated)."
|
||||
openapi: "get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/runs/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Get Dream Stats"
|
||||
description: "Lifecycle and synthesis counts for a project, plus reflection freshness."
|
||||
openapi: "get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/stats/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Update Dream Configuration"
|
||||
description: "Enable or disable Synthesis (reflection) for a project, or change the reflection mode."
|
||||
openapi: "patch /api/v1/orgs/organizations/{org_id}/projects/{project_id}/dream/config/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: 'Delete User'
|
||||
description: "Remove a user entity from the Mem0 platform by entity type and ID using the DELETE endpoint."
|
||||
description: "Send a DELETE request to /v2/entities/{entity_type}/{entity_id}/ to permanently remove a user entity from your Mem0 project by ID."
|
||||
openapi: delete /v2/entities/{entity_type}/{entity_id}/
|
||||
---
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: 'Get Users'
|
||||
description: "Retrieve a list of all user entities stored in the Mem0 platform using the GET endpoint."
|
||||
description: "Send a GET /v1/entities request to list every user entity in your Mem0 project, returning IDs, names, created_at, and metadata fields."
|
||||
openapi: get /v1/entities/
|
||||
---
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 'Get Event'
|
||||
description: "Retrieve details of a specific event by ID, including status and payload for async memory operations."
|
||||
description: "Fetch details of a specific Mem0 event by its event_id, including status, payload, and completion info for async memory operations."
|
||||
openapi: get /v1/event/{event_id}/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 'Get Events'
|
||||
description: "List recent events for your organization and project, useful for dashboards, alerting, and audit logging."
|
||||
description: "List recent events for your Mem0 organization and project to power dashboards, alerting on FAILED writes, and audit logging pipelines."
|
||||
openapi: get /v1/events/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Add Memories
|
||||
description: "Add facts, messages, or metadata to a user memory store with async processing and event tracking via the V3 additive pipeline."
|
||||
openapi: post /v3/memories/add/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Batch Delete Memories'
|
||||
description: "Delete multiple memories in a single batch request using the Mem0 API DELETE endpoint."
|
||||
openapi: delete /v1/batch/
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Batch Update Memories'
|
||||
description: "Update multiple memories in a single batch request using the Mem0 API PUT endpoint."
|
||||
openapi: put /v1/batch/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: 'Create Memory Export'
|
||||
description: "Submit an export job to create a structured memory export using a customizable Pydantic schema and filters."
|
||||
openapi: post /v1/exports/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Delete Memories'
|
||||
description: "Delete all memories matching specified filters from the Mem0 memory store using the DELETE endpoint."
|
||||
openapi: delete /v1/memories/
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "Delete Memory API Endpoint"
|
||||
sidebarTitle: "Delete Memory"
|
||||
description: "Delete a single memory by its unique memory ID from the Mem0 platform using the DELETE endpoint."
|
||||
openapi: delete /v1/memories/{memory_id}/
|
||||
---
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Feedback'
|
||||
description: "Submit positive or negative feedback on memory results to help improve memory accuracy and relevance."
|
||||
openapi: post /v1/feedback/
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "Get Memories"
|
||||
description: "Retrieve memories with paginated results and advanced filtering using logical operators like AND, OR, NOT, and comparison queries."
|
||||
openapi: post /v3/memories/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: 'Get Memory Export'
|
||||
description: "Retrieve the latest structured memory export after submitting an export job, with optional entity filters."
|
||||
openapi: post /v1/exports/get
|
||||
---
|
||||
|
||||
Retrieve the latest structured memory export after submitting an export job. You can filter the export by `user_id`, `agent_id`, `app_id`, `run_id`, `created_at`, or `updated_at` to get the most recent export matching your filters.
|
||||
Retrieve the latest structured memory export after submitting an export job. You can filter the export by `user_id`, `agent_id`, `app_id`, `run_id`, `created_at`, or `updated_at` to get the most recent export matching your filters.
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Get Memory'
|
||||
description: "Retrieve a single memory by its unique memory ID from the Mem0 platform using the GET endpoint."
|
||||
openapi: get /v1/memories/{memory_id}/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Memory History'
|
||||
description: "Retrieve the full change history of a specific memory to track how it has evolved over time."
|
||||
openapi: get /v1/memories/{memory_id}/history/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: 'Search Memories'
|
||||
description: "Search memories with hybrid retrieval (semantic + BM25 + entity matching) and advanced filtering using logical and comparison operators."
|
||||
openapi: post /v3/memories/search/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: "Update Memory API Endpoint"
|
||||
sidebarTitle: "Update Memory"
|
||||
description: "Update the content, metadata, timestamp, or expiration date of a single memory by its unique ID using the PUT endpoint."
|
||||
openapi: put /v1/memories/{memory_id}/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: "Add Organization Member API Endpoint"
|
||||
sidebarTitle: "Add Member"
|
||||
description: "Add a new member to an organization with a specified role such as READER or OWNER access level."
|
||||
openapi: post /api/v1/orgs/organizations/{org_id}/members/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Create Organization'
|
||||
description: "Create a new organization on the Mem0 platform to manage projects, members, and memory resources."
|
||||
openapi: post /api/v1/orgs/organizations/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Delete Organization'
|
||||
description: "Permanently delete an organization and its associated resources from the Mem0 platform."
|
||||
openapi: delete /api/v1/orgs/organizations/{org_id}/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "Get Organization Members API Endpoint"
|
||||
sidebarTitle: "Get Members"
|
||||
description: "Retrieve a list of all members belonging to a specific organization on the Mem0 platform."
|
||||
openapi: get /api/v1/orgs/organizations/{org_id}/members/
|
||||
---
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Get Organization'
|
||||
description: "Retrieve details of a specific organization by its ID from the Mem0 platform using the GET endpoint."
|
||||
openapi: get /api/v1/orgs/organizations/{org_id}/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: 'Get Organizations'
|
||||
description: "Retrieve a list of all organizations associated with your Mem0 account using the GET endpoint."
|
||||
description: "Call GET /api/v1/orgs/organizations to retrieve every organization tied to your Mem0 account, including IDs, names, and role metadata."
|
||||
openapi: get /api/v1/orgs/organizations/
|
||||
---
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Remove Organization Member"
|
||||
description: "Remove a member from an organization to revoke their access to its projects and resources."
|
||||
description: "Send a DELETE request to remove a member from a Mem0 organization and revoke their access to all of its projects, memories, and resources."
|
||||
openapi: "delete /api/v1/orgs/organizations/{org_id}/members/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Update Organization Member"
|
||||
description: "Update an existing member's role within an organization to change their permissions and access level."
|
||||
openapi: "put /api/v1/orgs/organizations/{org_id}/members/"
|
||||
---
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Organizations & Projects
|
||||
icon: "building"
|
||||
description: "Manage multi-tenant applications with organization and project APIs"
|
||||
description: "Manage multi-tenant Mem0 apps with the organizations and projects APIs, covering isolation, access control, API keys, and team collaboration."
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Generate Profiles'
|
||||
description: "Start one generation: sample a few entities, or build one for a single entity."
|
||||
openapi: post /v2/profiles/jobs/
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Get Generation Job'
|
||||
description: "Read the progress of a generation, and whether it finished."
|
||||
openapi: get /v2/profiles/jobs/{job_id}/
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Get Profile Settings'
|
||||
description: "Retrieve the profile schema, custom instructions, and enabled flag for the current project."
|
||||
openapi: get /v2/profiles/settings/
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Get Profile'
|
||||
description: "Retrieve the structured profile for a user, with a status describing whether generation has completed."
|
||||
openapi: get /v2/entities/{entity_type}/{entity_id}/profile/
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Update Profile Settings'
|
||||
description: "Set the JSON Schema, custom instructions, or enabled flag that control profile generation for the project."
|
||||
openapi: post /v2/profiles/settings/
|
||||
---
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: "Add Project Member API Endpoint"
|
||||
sidebarTitle: "Add Member"
|
||||
description: "Add a new member to a project with a specified role such as READER or OWNER access level."
|
||||
openapi: post /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Create Project'
|
||||
description: "Create a new project within an organization on the Mem0 platform to isolate memory resources."
|
||||
openapi: post /api/v1/orgs/organizations/{org_id}/projects/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Delete Project'
|
||||
description: "Permanently delete a project and its associated data from the Mem0 platform by project ID."
|
||||
openapi: delete /api/v1/orgs/organizations/{org_id}/projects/{project_id}/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: "Get Project Members API Endpoint"
|
||||
sidebarTitle: "Get Members"
|
||||
description: "Retrieve a list of all members belonging to a specific project on the Mem0 platform."
|
||||
openapi: get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/
|
||||
---
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Get Project'
|
||||
description: "Retrieve details of a specific project by its organization and project ID using the GET endpoint."
|
||||
openapi: get /api/v1/orgs/organizations/{org_id}/projects/{project_id}/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Get Projects'
|
||||
description: "Retrieve a list of all projects within an organization on the Mem0 platform using the GET endpoint."
|
||||
openapi: get /api/v1/orgs/organizations/{org_id}/projects/
|
||||
---
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Remove Project Member"
|
||||
description: "Remove a member from a project to revoke their access to its memories, configuration, and resources."
|
||||
description: "Send a DELETE request to remove a member from a Mem0 project and revoke their access to its memories, settings, API keys, and resources."
|
||||
openapi: "delete /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Update Project Member"
|
||||
description: "Update an existing member's role within a project to change their permissions and access level."
|
||||
openapi: "put /api/v1/orgs/organizations/{org_id}/projects/{project_id}/members/"
|
||||
---
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: "Update Project"
|
||||
description: "Update a project's settings, including name, custom instructions, and other configuration options."
|
||||
openapi: "patch /api/v1/orgs/organizations/{org_id}/projects/{project_id}/"
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: 'Create Webhook'
|
||||
description: "Create a new webhook for a project to receive real-time notifications about memory events."
|
||||
openapi: post /api/v1/webhooks/projects/{project_id}/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
title: 'Delete Webhook'
|
||||
description: "Delete an existing webhook by its ID to stop receiving notifications for memory events."
|
||||
openapi: delete /api/v1/webhooks/{webhook_id}/
|
||||
---
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: 'Get Webhook'
|
||||
description: "Retrieve webhook configuration details for a specific project on the Mem0 platform."
|
||||
openapi: get /api/v1/webhooks/projects/{project_id}/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: 'Update Webhook'
|
||||
description: "Update an existing webhook configuration, such as its URL or event subscriptions, by webhook ID."
|
||||
openapi: put /api/v1/webhooks/{webhook_id}/
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Highlights"
|
||||
description: "Major product launches, headline features, and milestones for Mem0."
|
||||
description: "Highlights of major Mem0 product launches, headline features, integrations like n8n and Zapier, and milestones across the platform and SDKs."
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Platform"
|
||||
description: "Release notes for the Mem0 hosted platform: backend, dashboard, billing, and infrastructure changes."
|
||||
description: "Release notes for the Mem0 hosted platform covering backend APIs, dashboard, billing, temporal reasoning, search, and infrastructure updates."
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "SDK & Tools"
|
||||
description: "Release notes for the Mem0 Python SDK, TypeScript SDK, Vercel AI SDK, CLI, and editor plugins."
|
||||
description: "Release notes for the Mem0 Python SDK, TypeScript SDK, Vercel AI SDK, CLI, and editor plugins, including new vector stores and bug fixes."
|
||||
mode: "wide"
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "FastEmbed"
|
||||
description: "Configure FastEmbed as an embedding provider in Mem0 to generate embeddings locally using ONNX-based models without a GPU."
|
||||
description: "Run FastEmbed inside Mem0 to generate ONNX-based text embeddings locally on CPU without API keys, using models like gte-large or bge-small."
|
||||
---
|
||||
|
||||
You can use FastEmbed to run embedding models locally in Mem0. FastEmbed is an ONNX-based embedding library that runs efficiently on CPU without requiring a GPU or an external API key.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Hugging Face
|
||||
description: "Configure Hugging Face as an embedding provider in Mem0 for local embedding generation with open-source models."
|
||||
description: "Use Hugging Face embeddings in Mem0 via local sentence-transformers or a Text Embeddings Inference (TEI) endpoint for fast, self-hosted vectors."
|
||||
---
|
||||
|
||||
You can use embedding models from Huggingface to run Mem0 locally.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Vertex AI"
|
||||
description: "Configure Google Cloud Vertex AI as an embedding provider in Mem0 with support for task-specific embedding types."
|
||||
description: "Use Google Cloud Vertex AI embeddings in Mem0 with ADC authentication, gemini-embedding-001, and task-specific types for add, update, and search."
|
||||
---
|
||||
### Vertex AI
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Anthropic
|
||||
description: "Configure Anthropic Claude models as the LLM provider in Mem0 with API key setup and usage examples."
|
||||
description: "Use Anthropic Claude models such as claude-sonnet-4-6 as your Mem0 LLM with the ANTHROPIC_API_KEY, plus temperature and max token controls."
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: DeepSeek
|
||||
description: "Configure DeepSeek as an LLM provider in Mem0 with API key setup and optional custom endpoint configuration."
|
||||
description: "Use DeepSeek chat models such as deepseek-chat as a Mem0 LLM with the DEEPSEEK_API_KEY and an optional DEEPSEEK_API_BASE custom endpoint URL."
|
||||
---
|
||||
|
||||
To use DeepSeek LLM models, you have to set the `DEEPSEEK_API_KEY` environment variable. You can also optionally set `DEEPSEEK_API_BASE` if you need to use a different API endpoint (defaults to `https://api.deepseek.com`).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Groq
|
||||
description: "Configure Groq as an LLM provider in Mem0 for high-speed inference using LPU-powered language models."
|
||||
description: "Use Groq LPU-hosted models such as llama-3.3-70b-versatile as a Mem0 LLM for very low-latency inference with the GROQ_API_KEY environment variable."
|
||||
---
|
||||
|
||||
[Groq](https://groq.com/) is the creator of the world's first Language Processing Unit (LPU), providing exceptional speed performance for AI workloads running on their LPU Inference Engine.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "LiteLLM"
|
||||
description: "Use LiteLLM as an LLM provider in Mem0 to access over 100 language models through a unified interface."
|
||||
description: "Route Mem0 through LiteLLM to reach 100+ providers via one API in Python, or a LiteLLM proxy at LITELLM_API_BASE from the TypeScript SDK."
|
||||
---
|
||||
[Litellm](https://litellm.vercel.app/docs/) is compatible with over 100 large language models (LLMs), all using a standardized input/output format. You can explore the [available models](https://litellm.vercel.app/docs/providers) to use with Litellm. Ensure you set the `API_KEY` for the model you choose to use.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: MiniMax
|
||||
description: "Configure MiniMax as an LLM provider in Mem0 with API key setup and optional custom endpoint configuration."
|
||||
description: "Use MiniMax chat models like MiniMax-M2.7 as a Mem0 LLM with the MINIMAX_API_KEY and an optional MINIMAX_API_BASE custom endpoint override."
|
||||
---
|
||||
|
||||
To use MiniMax LLM models, you have to set the `MINIMAX_API_KEY` environment variable. You can also optionally set `MINIMAX_API_BASE` if you need to use a different API endpoint (defaults to `https://api.minimax.io/v1`).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Mistral AI
|
||||
description: "Configure Mistral AI as an LLM provider in Mem0 using the litellm integration and Mixtral model family."
|
||||
description: "Use Mistral AI models such as open-mixtral-8x7b as a Mem0 LLM through the litellm provider with the MISTRAL_API_KEY environment variable."
|
||||
---
|
||||
|
||||
To use mistral's models, please obtain the Mistral AI api key from their [console](https://console.mistral.ai/). Set the `MISTRAL_API_KEY` environment variable to use the model as given below in the example.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Sarvam AI
|
||||
description: "Configure Sarvam AI as an LLM provider in Mem0, specializing in Indian language support with the Sarvam-M model."
|
||||
description: "Use Sarvam AI models like sarvam-m as a Mem0 LLM for Indian language conversations, with reasoning_effort, frequency_penalty, and seed controls."
|
||||
---
|
||||
|
||||
**Sarvam AI** is an Indian AI company developing language models with a focus on Indian languages and cultural context. Their latest model **Sarvam-M** is designed to understand and generate content in multiple Indian languages while maintaining high performance in English.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: vLLM
|
||||
description: "Configure vLLM as an LLM provider in Mem0 for high-performance local inference with GPU-optimized serving."
|
||||
description: "Serve local models like Qwen2.5-32B-Instruct through a vLLM server and connect Mem0 to it via VLLM_BASE_URL for fast, GPU-optimized inference."
|
||||
---
|
||||
|
||||
[vLLM](https://docs.vllm.ai/) is a high-performance inference engine for large language models that provides significant performance improvements for local inference. It's designed to maximize throughput and memory efficiency for serving LLMs.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Config
|
||||
description: "Reference for shared and provider-specific reranker configuration options in Mem0, including top_k and API key settings."
|
||||
description: "Reference for Mem0 reranker configuration covering Cohere, Zero Entropy, sentence-transformer, HuggingFace, and LLM-based providers with top_k limits."
|
||||
---
|
||||
|
||||
## Common Configuration Parameters
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Custom Prompts
|
||||
description: "Customize the LLM reranker prompt template in Mem0 to control how search results are ranked and scored."
|
||||
description: "Write custom LLM reranker scoring prompts in Mem0 using query and document variables to tune relevance ranking for your specific domain or use case."
|
||||
---
|
||||
|
||||
When using LLM rerankers, you can customize the prompts used for ranking to better suit your specific use case and domain.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Cohere
|
||||
description: "Configure Cohere as a reranker in Mem0 with support for English and multilingual reranking models."
|
||||
description: "Use Cohere rerank-v3.5 or older v3.0 models as a Mem0 reranker for English and multilingual search relevance with COHERE_API_KEY authentication."
|
||||
---
|
||||
|
||||
Cohere provides enterprise-grade reranking models with excellent multilingual support and production-ready performance.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Hugging Face Reranker
|
||||
description: 'Access thousands of reranking models from Hugging Face Hub'
|
||||
description: 'Access thousands of Hugging Face Hub reranking models in Mem0, including BAAI BGE cross-encoders, to boost memory search relevance and precision.'
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: LLM Reranker
|
||||
description: 'Use any language model as a reranker with custom prompts'
|
||||
description: 'Use any Mem0-supported LLM as a reranker with custom prompts to score and rank memories by query relevance for flexible, tunable retrieval.'
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Sentence Transformer
|
||||
description: 'Local reranking with HuggingFace cross-encoder models'
|
||||
description: 'Run local reranking in Mem0 with Sentence Transformers cross-encoder models like ms-marco-MiniLM for privacy-focused, on-premises deployments.'
|
||||
---
|
||||
|
||||
Sentence Transformer reranker provides local reranking using HuggingFace cross-encoder models, perfect for privacy-focused deployments where you want to keep data on-premises.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Zero Entropy
|
||||
description: "Configure Zero Entropy neural reranking models in Mem0 with zerank-1 and zerank-1-small support."
|
||||
description: "Configure Zero Entropy neural reranking in Mem0 with the zerank-1 and zerank-1-small models for fast, high-relevance search over stored memories."
|
||||
---
|
||||
|
||||
[Zero Entropy](https://www.zeroentropy.dev) provides neural reranking models that significantly improve search relevance with fast performance.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Performance Optimization
|
||||
description: "Best practices for optimizing reranker performance in Mem0, covering candidate sizing, batching, and tuning."
|
||||
description: "Best practices for tuning reranker performance in Mem0, covering candidate set sizing, batching, model selection, and latency versus precision tradeoffs."
|
||||
---
|
||||
|
||||
Optimizing reranker performance is crucial for maintaining fast search response times while improving result quality. This guide covers best practices for different reranker types.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Reranker Providers Overview"
|
||||
sidebarTitle: "Overview"
|
||||
description: 'Pick the right reranker path to boost Mem0 search relevance.'
|
||||
description: "Compare Mem0 reranker providers (Cohere, Hugging Face, Sentence Transformers, LLM reranker, Zero Entropy) and boost vector search relevance."
|
||||
---
|
||||
|
||||
Mem0 rerankers rescore vector search hits so your agents surface the most relevant memories. Use this hub to decide when reranking helps, configure a provider, and fine-tune performance.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Azure MySQL
|
||||
description: "Use Azure Database for MySQL as a vector store in Mem0 with JSON-based vector storage for semantic search."
|
||||
description: "Use Azure Database for MySQL as a vector store in Mem0 with JSON-based vector storage for semantic memory search on a managed MySQL backend."
|
||||
---
|
||||
|
||||
[Azure Database for MySQL](https://azure.microsoft.com/products/mysql) is a fully managed relational database service that provides enterprise-grade reliability and security. It supports JSON-based vector storage for semantic search capabilities in AI applications.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Azure AI Search
|
||||
description: "Use Azure AI Search as a vector store in Mem0 for managed vector search with service name and API key setup."
|
||||
description: "Configure Azure AI Search as a managed vector store in Mem0 using your service name, API key, and index for secure, scalable memory retrieval."
|
||||
---
|
||||
|
||||
[Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search/) (formerly known as "Azure Cognitive Search") provides secure information retrieval at scale over user-owned content in traditional and generative AI search applications.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Baidu VectorDB (Mochow)
|
||||
description: "Use Baidu Mochow as an enterprise vector database in Mem0 for high-performance vector storage and retrieval."
|
||||
description: "Use Baidu VectorDB (Mochow) as an enterprise-grade vector store in Mem0 for high-performance, distributed vector storage and semantic retrieval."
|
||||
---
|
||||
|
||||
[Baidu VectorDB](https://cloud.baidu.com/doc/VDB/index.html) is an enterprise-level distributed vector database service developed by Baidu Intelligent Cloud. It is powered by Baidu's proprietary "Mochow" vector database kernel, providing high performance, availability, and security for vector search.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Apache Cassandra
|
||||
description: "Use Apache Cassandra as a distributed vector store in Mem0 with semantic search over large-scale datasets."
|
||||
description: "Use Apache Cassandra as a distributed NoSQL vector store in Mem0 for scalable, fault-tolerant semantic memory search over large-scale datasets."
|
||||
---
|
||||
|
||||
[Apache Cassandra](https://cassandra.apache.org/) is a highly scalable, distributed NoSQL database designed for handling large amounts of data across many commodity servers with no single point of failure. It supports vector storage for semantic search capabilities in AI applications and can scale to massive datasets with linear performance improvements.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Chroma"
|
||||
description: "Use Chroma as a vector database in Mem0 for local or cloud-hosted vector storage with built-in embedding support."
|
||||
description: "Use Chroma as an AI-native vector database in Mem0 for local or cloud-hosted embedding storage, quick prototyping, and simple LLM app development."
|
||||
---
|
||||
[Chroma](https://www.trychroma.com/) is an AI-native open-source vector database that simplifies building LLM apps by providing tools for storing, embedding, and searching embeddings with a focus on simplicity and speed. It supports both local deployment and cloud hosting through ChromaDB Cloud.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Databricks"
|
||||
description: "Use Databricks Vector Search as a serverless vector store in Mem0 with auto-updating indexes from Delta tables."
|
||||
description: "Use Databricks Vector Search as a serverless vector store in Mem0 with auto-updating indexes synced from Delta tables and Unity Catalog governance."
|
||||
---
|
||||
[Databricks Vector Search](https://docs.databricks.com/en/generative-ai/vector-search.html) is a serverless similarity search engine that allows you to store a vector representation of your data, including metadata, in a vector database. With Vector Search, you can create auto-updating vector search indexes from Delta tables managed by Unity Catalog and query them with a simple API to return the most similar vectors.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Elasticsearch"
|
||||
description: "Use Elasticsearch as a vector database in Mem0 for distributed vector search using dense vectors and k-NN queries."
|
||||
description: "Use Elasticsearch as a distributed vector database in Mem0 with dense vectors and k-NN queries for hybrid semantic and keyword memory search."
|
||||
---
|
||||
[Elasticsearch](https://www.elastic.co/) is a distributed, RESTful search and analytics engine that can efficiently store and search vector data using dense vectors and k-NN search.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "FAISS"
|
||||
description: "Use Facebook FAISS as a high-performance vector store in Mem0, optimized for memory usage and fast similarity search."
|
||||
description: "Use Meta FAISS as a high-performance local vector store in Mem0, optimized for memory usage and fast in-process similarity search over dense vectors."
|
||||
---
|
||||
[FAISS](https://github.com/facebookresearch/faiss) is a library for efficient similarity search and clustering of dense vectors. It is designed to work with large-scale datasets and provides a high-performance search engine for vector data. FAISS is optimized for memory usage and search speed, making it an excellent choice for production environments.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Milvus"
|
||||
description: "Use Milvus as an open-source vector database in Mem0, scalable from local development to production workloads."
|
||||
description: "Use Milvus as an open-source vector database in Mem0, scaling from Jupyter notebook demos to production similarity search across billions of vectors."
|
||||
---
|
||||
[Milvus](https://milvus.io/) is an open-source vector database that suits AI applications of every size, from running a demo chatbot in a Jupyter notebook to building web-scale search that serves billions of users.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "MongoDB"
|
||||
description: "Use MongoDB as a vector database in Mem0 with built-in vector search for high-dimensional similarity queries."
|
||||
description: "Use MongoDB Atlas as a vector database in Mem0 with native vector search for high-dimensional similarity queries alongside your document data."
|
||||
---
|
||||
|
||||
# MongoDB
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Neon"
|
||||
description: "Use Neon as a vector store in Mem0, powered by PostgreSQL and pgvector."
|
||||
description: "Use Neon serverless Postgres with the pgvector extension as a vector store in Mem0 for autoscaling, branchable memory storage with a Postgres URL."
|
||||
---
|
||||
|
||||
Use [Neon](https://neon.com/) as a vector store in Mem0, powered by PostgreSQL and the
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Neptune Analytics"
|
||||
description: "Use AWS Neptune Analytics as a vector store in Mem0, combining graph analytics with vector search capabilities."
|
||||
description: "Use AWS Neptune Analytics as a memory-optimized vector store in Mem0, combining graph analytics with vector search for connected data insights."
|
||||
---
|
||||
|
||||
[Neptune Analytics](https://docs.aws.amazon.com/neptune-analytics/latest/userguide/what-is-neptune-analytics.html) is a memory-optimized graph database engine for analytics. With Neptune Analytics, you can get insights and find trends by processing large amounts of graph data in seconds, including vector search.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "OpenSearch"
|
||||
description: "Use OpenSearch as a vector database in Mem0 with k-NN search support via AWS OpenSearch Service serverless collections."
|
||||
description: "Use OpenSearch as a vector database in Mem0 with k-NN search over dense embeddings, including AWS OpenSearch Service serverless collections."
|
||||
---
|
||||
[OpenSearch](https://opensearch.org/) is an enterprise-grade search and observability suite that brings order to unstructured data at scale. OpenSearch supports k-NN (k-Nearest Neighbors) and allows you to store and retrieve high-dimensional vector embeddings efficiently.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Oracle AI Vector Search"
|
||||
description: "Use Oracle Database AI Vector Search as a vector store in Mem0 for semantic and relational queries."
|
||||
description: "Use Oracle Database AI Vector Search as a vector store in Mem0 with the native VECTOR type to combine semantic memory search and relational queries."
|
||||
---
|
||||
|
||||
{/* Copyright (c) 2026, Oracle and/or its affiliates. */}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "pgvector"
|
||||
description: "Use pgvector as a vector store in Mem0 for PostgreSQL-based vector similarity search with open-source simplicity."
|
||||
description: "Use the pgvector extension as a vector store in Mem0 for PostgreSQL-based similarity search with open-source simplicity and standard SQL tooling."
|
||||
---
|
||||
|
||||
[pgvector](https://github.com/pgvector/pgvector) is an open-source vector similarity search extension for Postgres. After connecting to Postgres, run `CREATE EXTENSION IF NOT EXISTS vector;` to create the vector extension.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Pinecone"
|
||||
description: "Use Pinecone as a fully managed vector database in Mem0 with serverless deployment and namespace-based multi-tenancy."
|
||||
description: "Use Pinecone as a fully managed vector database in Mem0 with serverless indexes and namespace-based multi-tenancy for low-latency semantic search."
|
||||
---
|
||||
[Pinecone](https://www.pinecone.io/) is a fully managed vector database designed for machine learning applications, offering high performance vector search with low latency at scale. It's particularly well-suited for semantic search, recommendation systems, and other AI-powered applications.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Qdrant"
|
||||
description: "Use Qdrant as an open-source vector search engine in Mem0 for high-performance similarity search at scale."
|
||||
description: "Use Qdrant as an open-source vector search engine in Mem0 for high-performance, filterable similarity search at scale, self-hosted or on Qdrant Cloud."
|
||||
---
|
||||
[Qdrant](https://qdrant.tech/) is an open-source vector search engine. It is designed to work with large-scale datasets and provides a high-performance search engine for vector data.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Redis"
|
||||
description: "Use Redis as a real-time vector database in Mem0 for fast vector search using Redis Stack and redisvl."
|
||||
description: "Use Redis as a real-time vector database in Mem0 for fast in-memory similarity search using Redis Stack, the RediSearch module, and the redisvl client."
|
||||
---
|
||||
[Redis](https://redis.io/) is a scalable, real-time database that can store, search, and analyze vector data.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Amazon S3 Vectors
|
||||
description: "Use Amazon S3 Vectors as a cost-optimized vector storage service in Mem0 with AWS credential authentication."
|
||||
description: "Use Amazon S3 Vectors as a cost-optimized vector storage service in Mem0 with AWS credential auth, sub-second queries, and S3-level durability."
|
||||
---
|
||||
|
||||
[Amazon S3 Vectors](https://aws.amazon.com/s3/features/vectors/) is a purpose-built, cost-optimized vector storage and query service for semantic search and AI applications. It provides S3-level elasticity and durability with sub-second query performance.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Supabase"
|
||||
description: "Use Supabase as a vector store in Mem0, powered by PostgreSQL and pgvector with HNSW indexing support."
|
||||
description: "Use Supabase as a vector store in Mem0, backed by PostgreSQL and the pgvector extension with HNSW indexing for scalable embedding search."
|
||||
---
|
||||
[Supabase](https://supabase.com/) is an open-source Firebase alternative that provides a PostgreSQL database with pgvector extension for vector similarity search. It offers a powerful and scalable solution for storing and querying vector embeddings.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Turbopuffer"
|
||||
description: "Use Turbopuffer as a serverless vector database in Mem0 for low-latency search at scale with native metadata filtering."
|
||||
description: "Use Turbopuffer as a serverless vector database in Mem0 for low-latency search at scale with native metadata filtering and cost-effective storage."
|
||||
---
|
||||
[Turbopuffer](https://turbopuffer.com) is a serverless vector database optimized for low-latency search at scale. It offers cost-effective vector storage with native metadata filtering.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Upstash Vector"
|
||||
description: "Use Upstash Vector as a serverless vector database in Mem0 with optional built-in embedding models."
|
||||
description: "Use Upstash Vector as a serverless vector database in Mem0 with optional built-in embedding models for zero-infrastructure memory search over HTTP."
|
||||
---
|
||||
[Upstash Vector](https://upstash.com/docs/vector) is a serverless vector database with built-in embedding models.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Valkey"
|
||||
description: "Use Valkey as an open-source vector store in Mem0 for high-performance key-value storage with vector search."
|
||||
description: "Use Valkey as an open-source, BSD-licensed key-value datastore in Mem0 for high-performance vector search alongside rich data structures and caching."
|
||||
---
|
||||
# Valkey Vector Store
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Cloudflare Vectorize"
|
||||
description: "Use Cloudflare Vectorize as a vector database in Mem0 for building AI-powered applications at the edge."
|
||||
description: "Use Cloudflare Vectorize as a vector database in Mem0 for building AI-powered applications at the edge with globally distributed embedding search."
|
||||
---
|
||||
[Cloudflare Vectorize](https://developers.cloudflare.com/vectorize/) is a vector database offering from Cloudflare, allowing you to build AI-powered applications with vector embeddings.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user