ContextQMD
Back to Mem0

Overview

docs/api-reference.mdx

2.0.13.5 KB
Original Source

Mem0 REST API

Mem0 provides a comprehensive REST API for integrating advanced memory capabilities into your applications. Create, search, update, and manage memories across users, agents, and custom entities with simple HTTP requests.

<Info> **Quick start:** Get your API key from the <a href="https://app.mem0.ai/dashboard/api-keys?utm_source=oss&utm_medium=api-reference" rel="nofollow">Mem0 Dashboard</a> and make your first memory operation in minutes. </Info>

Quick Start Guide

Get started with Mem0 API in three simple steps:

  1. Add Memories - Store information and context from user conversations
  2. Search Memories - Retrieve relevant memories using semantic search
  3. Get Memories - Fetch all memories for a specific entity

Core Operations

<CardGroup cols={2}> <Card title="Add Memories" icon="plus" href="/api-reference/memory/add-memories"> Store new memories from conversations and interactions </Card> <Card title="Search Memories" icon="magnifying-glass" href="/api-reference/memory/search-memories"> Find relevant memories using semantic search with filters </Card> <Card title="Update Memory" icon="pen" href="/api-reference/memory/update-memory"> Modify existing memory content and metadata </Card> <Card title="Delete Memory" icon="trash" href="/api-reference/memory/delete-memory"> Remove specific memories or batch delete operations </Card> </CardGroup>

API Categories

Explore the full API organized by functionality:

<CardGroup cols={2}> <Card title="Memory APIs" icon="microchip" href="/api-reference/memory/add-memories"> Core and advanced operations: CRUD, search, batch updates, history, and exports </Card> <Card title="Events APIs" icon="clock" href="/api-reference/events/get-events"> Track and monitor the status of asynchronous memory operations </Card> <Card title="Entities APIs" icon="users" href="/api-reference/entities/get-users"> Manage users, agents, and their associated memory data </Card> <Card title="Organizations & Projects" icon="building" href="/api-reference/organizations-projects"> Multi-tenant support, access control, and team collaboration </Card> <Card title="Webhooks" icon="webhook" href="/api-reference/webhook/create-webhook"> Real-time notifications for memory events and updates </Card> </CardGroup> <Note> **Building multi-tenant apps?** Learn about [Organizations & Projects](/api-reference/organizations-projects) for team isolation and access control. </Note>

Authentication

All API requests require authentication using Token-based authentication. Include your API key in the Authorization header:

bash
Authorization: Token <your-api-key>

Get your API key from the <a href="https://app.mem0.ai/dashboard/api-keys?utm_source=oss&utm_medium=api-reference" rel="nofollow">Mem0 Dashboard</a>.

<Warning> **Keep your API key secure.** Never expose it in client-side code or public repositories. Use environment variables and server-side requests only. </Warning>

Next Steps

<CardGroup cols={2}> <Card title="Add Your First Memory" icon="rocket" href="/api-reference/memory/add-memories"> Start storing memories via the REST API </Card> <Card title="Search with Filters" icon="filter" href="/api-reference/memory/search-memories"> Learn advanced search and filtering techniques </Card> </CardGroup>