Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 30 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
memU-server is the backend management service for MemU, responsible for providing API endpoints, data storage, and management capabilities, as well as deep integration with the core memU framework. It powers the frontend memU-ui with reliable data support, ensuring efficient reading, writing, and maintenance of Agent memories. memU-server can be deployed locally or in private environments and supports quick startup and configuration via Docker, enabling developers to manage the AI memory system in a secure environment.

- Core Algorithm 👉 memU: https://github.com/NevaMind-AI/memU
- Local visual interface 👉 memU-ui: https://github.com/NevaMind-AI/memU-ui
- One call = response + memory 👉 memU Response API: https://memu.pro/docs#responseapi
- Try it instantly 👉 https://app.memu.so/quick-start
- Try MemU cloud version instantly 👉 https://app.memu.so/quick-start

---

Expand Down Expand Up @@ -35,11 +36,11 @@ Star memU-server to get notified about new releases and join our growing communi
```
The server runs on `http://127.0.0.1:8000`.

### Run with Docker
1. Export your OpenAI API key so Docker can read it:
```bash
export OPENAI_API_KEY=your_api_key_here
```
### Run with Docker
1. Export your OpenAI API key so Docker can read it:
```bash
export OPENAI_API_KEY=your_api_key_here
```
2. Pull the latest image:
```bash
docker pull nevamindai/memu-server:latest
Expand All @@ -49,28 +50,28 @@ Star memU-server to get notified about new releases and join our growing communi
docker run --rm -p 8000:8000 \
-e OPENAI_API_KEY=$OPENAI_API_KEY \
nevamindai/memu-server:latest
```
Access the API at `http://127.0.0.1:8000`.

### API Endpoints
- `POST /memorize`: persist a conversation-style payload for later retrieval. Example body shape:
```json
{
"content": [
{"role": "user", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"},
{"role": "assistant", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"}
]
}
```
- `POST /retrieve`: query stored memories with a text prompt:
```json
{"query": "your question about the conversation"}
```
- To smoke-test locally, set `MEMU_API_URL` (defaults to `http://127.0.0.1:12345`), POST a conversation to `/memorize`, then call `/retrieve` with a text query.

---

## 🔑 Key Features
```
Access the API at `http://127.0.0.1:8000`.
### API Endpoints
- `POST /memorize`: persist a conversation-style payload for later retrieval. Example body shape:
```json
{
"content": [
{"role": "user", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"},
{"role": "assistant", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"}
]
}
```
- `POST /retrieve`: query stored memories with a text prompt:
```json
{"query": "your question about the conversation"}
```
- To smoke-test locally, set `MEMU_API_URL` (defaults to `http://127.0.0.1:12345`), POST a conversation to `/memorize`, then call `/retrieve` with a text query.
---
## 🔑 Key Features

### Quick Deployment
- Docker image provided
Expand Down Expand Up @@ -130,3 +131,4 @@ For more information please contact info@nevamind.ai
- GitHub Issues: Report bugs, request features, and track development. [Submit an issue](https://github.com/NevaMind-AI/memU-server/issues)
- Discord: Get real-time support, chat with the community, and stay updated. [Join us](https://discord.com/invite/hQZntfGsbJ)
- X (Twitter): Follow for updates, AI insights, and key announcements. [Follow us](https://x.com/memU_ai)