REST API Server

Documentation Index

Fetch the complete documentation index at: https://docs.mem0.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Feature

• CRUD endpoints: Create, retrieve, search, update, delete, and reset memories by user_id, agent_id, or run_id.
• Authentication: On by default. Dashboard sessions use JWTs; programmatic clients use per-user X-API-Key headers. Legacy ADMIN_API_KEY is still supported.
• Status health check: Access base routes to confirm the server is online.
• OpenAPI explorer: Visit /docs for interactive testing and schema reference.

​

Configure it

​

Run with Docker Compose (development)

docker pull mem0/mem0-api-server

docker build -t mem0-api-server .

docker run -p 8000:8000 --env-file .env mem0-api-server

pip install -r requirements.txt
uvicorn main:app --reload

​

Authentication

​

Log in and use a JWT

# First admin only — returns 403 after the first admin is registered
curl -X POST http://localhost:8888/auth/register \
  -H "Content-Type: application/json" \
  -d '{"name": "Admin", "email": "[email protected]", "password": "strong-password"}'

curl -X POST http://localhost:8888/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "password": "your-password"}'

curl -X POST http://localhost:8888/memories \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
    "messages": [{"role": "user", "content": "I love pizza."}],
    "user_id": "alice"
  }'

​

Create and use a per-user API key

curl -X POST http://localhost:8888/memories \
  -H "Content-Type: application/json" \
  -H "X-API-Key: m0sk_your_key_here" \
  -d '{
    "messages": [{"role": "user", "content": "I love pizza."}],
    "user_id": "alice"
  }'

​

Legacy ADMIN_API_KEY

ADMIN_API_KEY=your-long-admin-key

​

See it in action

​

Create and search memories via HTTP

curl -X POST http://localhost:8888/memories \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {"role": "user", "content": "I love fresh vegetable pizza."}
    ],
    "user_id": "alice"
  }'

curl -X POST http://localhost:8888/search \
  -H "Content-Type: application/json" \
  -d '{
    "query": "vegetable",
    "user_id": "alice"
  }'

​

Explore with OpenAPI docs

1. Navigate to http://localhost:8888/docs (Compose) or http://localhost:8000/docs (raw Docker / uvicorn).
2. Pick an endpoint (e.g., POST /search).
3. Fill in parameters and click Execute to try requests in-browser.

​

Endpoint reference

​

Memory operations

​

Authentication

​

API keys

​

Request logs

​

Entities

​

Verify the feature is working

• Hit the root route and /docs to confirm the server is reachable.
• Run a full cycle: POST /memories → GET /memories/{id} → DELETE /memories/{id}.
• Watch server logs for import errors or provider misconfigurations during startup.
• Confirm environment variables (API keys, vector store credentials) load correctly when containers restart.

​

Best practices

1. Keep auth on: Auth is enabled by default. Never set AUTH_DISABLED=true in production. If you rely on ADMIN_API_KEY, use a long value (16+ chars) or prefer per-user API keys.
2. Use HTTPS: Terminate TLS at your load balancer or reverse proxy.
3. Monitor uptime: Track request rates, latency, and error codes per endpoint.
4. Version configs: Keep environment files and Docker Compose definitions in source control.
5. Limit exposure: Bind to private networks unless you explicitly need public access.