Get up and running with Mem0 Platform quickly. This guide covers the essential steps to start storing and retrieving memories.

​
1. Installation

pip install mem0ai

​
2. API Key Setup

  1. Sign in to Mem0 Platform
  2. Copy your API Key from the dashboard
Get API Key from Mem0 Platform

​
3. Initialize Client

import os
from mem0 import MemoryClient

os.environ["MEM0_API_KEY"] = "your-api-key"
client = MemoryClient()

​
4. Basic Operations

​
Add Memories

Store user preferences and context: 
messages = [
    {"role": "user", "content": "Hi, I'm Alex. I'm a vegetarian and allergic to nuts."},
    {"role": "assistant", "content": "Hello Alex! I'll remember your dietary preferences."}
]

result = client.add(messages, user_id="alex")
print(result)

​
Search Memories

Retrieve relevant memories based on queries: 
query = "What should I cook for dinner?"
results = client.search(query, user_id="alex")
print(results)

​
Get All Memories

Fetch all memories for a user: 
memories = client.get_all(user_id="alex")
print(memories)

​
5. Memory Types

​
User Memories

Long-term memories that persist across sessions: 
client.add(messages, user_id="alex", metadata={"category": "preferences"})

​
Session Memories

Short-term memories for specific conversations: 
client.add(messages, user_id="alex", run_id="session-123")

​
Agent Memories

Memories for AI assistants and agents: 
client.add(messages, agent_id="support-bot")

​
6. Advanced Features

​
Async Processing

Process memories in the background for faster responses: 
client.add(messages, user_id="alex", async_mode=True)

​
Search with Filters

Filter results by categories and metadata: 
results = client.search(
    "food preferences", 
    user_id="alex",
    categories=["preferences"],
    metadata={"category": "food"}
)

​
TypeScript Example

import MemoryClient, { Message, MemoryOptions } from 'mem0ai';

const client = new MemoryClient('your-api-key');

const messages: Message[] = [
    { role: "user", content: "I love Italian food" },
    { role: "assistant", content: "Noted! I'll remember your preference for Italian cuisine." }
];

const options: MemoryOptions = {
    user_id: "alex",
    metadata: { category: "food_preferences" }
};

client.add(messages, options)
    .then(result => console.log(result))
    .catch(error => console.error(error));

​
Next Steps

Now that you’re up and running, explore more advanced features:

Discord

Join our community

GitHub

Ask questions on GitHub

Support

Talk to founders