Quick Start Guide
Get started with Mem0 API in three simple steps:- Add Memories - Store information and context from user conversations
- Search Memories - Retrieve relevant memories based on queries
- Get Memories - Fetch all memories for a specific entity
Common Operations
Add Memories
Store new memories from conversations and interactions
Search Memories
Find relevant memories using semantic search
Update Memory
Modify existing memory content
Delete Memory
Remove specific memories or batch delete
API Structure
Our API is organized into several main categories:- Memory APIs: Core operations for managing individual memories and collections
- Entities APIs: Manage different entity types (users, agents, etc.) and their associated memories
- Organizations APIs: Manage organizations and their members (optional)
- Project APIs: Manage projects within organizations (optional)
Authentication
All API requests require authentication using Token-based authentication. Include your API key in the Authorization header:Organizations and projects (optional)
Organizations and projects provide the following capabilities:- Multi-org/project Support: Specify organization and project when initializing the Mem0 client to attribute API usage appropriately.
- Member Management: Control access to data through organization and project membership.
- Access Control: Only members can access memories and data within their organization/project scope.
- Team Isolation: Maintain data separation between different teams and projects for secure collaboration.
- Python
- Node.js
Project Management Methods
The Mem0 client provides comprehensive project management capabilities through theclient.project
interface:
Get Project Details
Retrieve information about the current project:Create a New Project
Create a new project within your organization:Update Project Settings
Modify project configuration including custom instructions, categories, and graph settings:Delete Project
This action will remove all memories, messages, and other related data in the project. This operation is irreversible.
Member Management
Manage project members and their access levels:Member Roles
- READER: Can view and search memories, but cannot modify project settings or manage members.
- OWNER: Full access including project modification, member management, and all reader permissions.
Async Support
All project methods are also available in async mode:Getting Started
To begin using the Mem0 API, you’ll need to:- Sign up for a Mem0 account and obtain your API key.
- Familiarize yourself with the API endpoints and their functionalities.
- Make your first API call to add or retrieve a memory.