Update docs for running REST API Server (#2241)

This commit is contained in:
Deshraj Yadav
2025-02-21 01:26:57 -08:00
committed by GitHub
parent 244fd2231d
commit 96628d7791
4 changed files with 19 additions and 52 deletions

View File

@@ -31,16 +31,30 @@ Mem0 provides a REST API server (written using FastAPI). Users can perform all o
OPENAI_API_KEY=your-openai-api-key
```
2. Build the Docker image:
2. Either pull the docker image from docker hub or build the docker image locally.
<Tabs>
<Tab title="Pull from Docker Hub">
```bash
docker pull mem0/mem0-api-server
```
</Tab>
<Tab title="Build Locally">
```bash
docker build -t mem0-api-server .
```
</Tab>
</Tabs>
3. Run the Docker container:
``` bash
docker run -p 8000:8000 mem0-api-server
docker run -p 8000:8000 mem0-api-server --env-file .env
```
4. Access the API at http://localhost:8000.

View File

@@ -6,7 +6,6 @@ COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
COPY .env .
COPY . .
EXPOSE 8000

View File

@@ -2,6 +2,6 @@ build:
docker build -t mem0-api-server .
run_local:
docker run -p 8000:8000 -v $(shell pwd):/app mem0-api-server
docker run -p 8000:8000 -v $(shell pwd):/app mem0-api-server --env-file .env
.PHONY: build run_local

View File

@@ -12,52 +12,6 @@ Mem0 provides a REST API server (written using FastAPI). Users can perform all o
- **Reset memories:** Reset all memories for a user, agent, or run.
- **OpenAPI Documentation:** Accessible via `/docs` endpoint.
## Running Locally
## Running the server
### With Docker
1. Create a `.env` file in the root directory of the project and set your environment variables. For example:
```env
OPENAI_API_KEY=your-openai-api-key
```
2. Build the Docker image:
```bash
docker build -t mem0-api-server .
```
3. Run the Docker container:
``` bash
docker run -p 8000:8000 mem0-api-server
```
4. Access the API at http://localhost:8000.
### Without Docker
1. Create a `.env` file in the root directory of the project and set your environment variables. For example:
```env
OPENAI_API_KEY=your-openai-api-key
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Start the FastAPI server:
```bash
uvicorn main:app --reload
```
4. 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`](http://localhost:8000/docs) endpoint.
Follow the instructions in the [docs](https://docs.mem0.ai/open-source/features/rest-api) to run the server.