Mem0 provides a REST API server (written using FastAPI). Users can perform all operations through REST endpoints. The API also includes OpenAPI documentation, accessible at /docs when the server is running.

APIs supported by Mem0 REST API Server

​
Features

  • Create memories: Create memories based on messages for a user, agent, or run.
  • Retrieve memories: Get all memories for a given user, agent, or run.
  • Search memories: Search stored memories based on a query.
  • Update memories: Update an existing memory.
  • Delete memories: Delete a specific memory or all memories for a user, agent, or run.
  • Reset memories: Reset all memories for a user, agent, or run.
  • OpenAPI Documentation: Accessible via /docs endpoint.

​
Running Locally

  1. Create a .env file in the current directory and set your environment variables. For example:
OPENAI_API_KEY=your-openai-api-key
  1. Either pull the docker image from docker hub or build the docker image locally.
docker pull mem0/mem0-api-server
  1. Run the Docker container:
docker run -p 8000:8000 mem0-api-server --env-file .env
  1. Access the API at http://localhost:8000.

​
Usage

Once the server is running (locally or via Docker), you can interact with it using any REST client or through your preferred programming language (e.g., Go, Java, etc.). You can test out the APIs using the OpenAPI documentation at http://localhost:8000/docs endpoint.

Previous
Overview
Next