You’ll use this when…
- Your services already talk to REST APIs and you want Mem0 to match that style.
- Teams on languages without the Mem0 SDK still need access to memories.
- You plan to explore or debug endpoints through the built-in OpenAPI page at
/docs.
Add your own authentication and HTTPS before exposing the server to anything beyond your internal network. The default image does not include auth.
Feature
- CRUD endpoints: Create, retrieve, search, update, delete, and reset memories by
user_id,agent_id, orrun_id. - Status health check: Access base routes to confirm the server is online.
- OpenAPI explorer: Visit
/docsfor interactive testing and schema reference.
Configure it
Run with Docker Compose (development)
- Steps
- Create
server/.envwith your keys:
- Start the stack:
- Reach the API at
http://localhost:8888. Edits to the server or library auto-reload.
Run with Docker
- Pull image
- Build locally
- Create a
.envfile withOPENAI_API_KEY. - Run the container:
- Visit
http://localhost:8000.
Run directly (no Docker)
Use a process manager such as
systemd, Supervisor, or PM2 when deploying the FastAPI server for production resilience.The REST server reads the same configuration you use locally, so you can point it at your preferred LLM, vector store, graph backend, and reranker without changing code.
See it in action
Create and search memories via HTTP
Expect a JSON response containing the new memory IDs and events (
ADD, etc.).Explore with OpenAPI docs
- Navigate to
http://localhost:8000/docs. - Pick an endpoint (e.g.,
POST /memories/search). - Fill in parameters and click Execute to try requests in-browser.
Export the generated
curl snippets from the OpenAPI UI to bootstrap integration tests.Verify the feature is working
- Hit the root route and
/docsto 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
- Add authentication: Protect endpoints with API gateways, proxies, or custom FastAPI middleware.
- Use HTTPS: Terminate TLS at your load balancer or reverse proxy.
- Monitor uptime: Track request rates, latency, and error codes per endpoint.
- Version configs: Keep environment files and Docker Compose definitions in source control.
- Limit exposure: Bind to private networks unless you explicitly need public access.