Documentation
Private long-term memory for your AI agent. Start in the dashboard, generate an API key, send one message to your AI, and let it install Mimir locally.
What is Mimir?
Mimir gives your AI agent a permanent brain. Every conversation, every fact, every relationship — remembered across sessions, forever.
Instead of losing context when a chat ends, your AI builds up knowledge about you over time: your preferences, your projects, the people you mention, the decisions you make. Next time you talk, it just **knows**.
**How is this different from chat history?**
Chat history is a raw log. Mimir is a knowledge graph — it extracts structured facts, entities, relationships, and timelines from your conversations. When your AI needs context, it retrieves exactly the relevant pieces, not entire chat transcripts.
**Compatible with:**
Claude Code, Cursor, OpenClaw, and any AI agent that supports plugins or tool use.
How It Works
Mimir has two automatic systems that run silently in the background:
**Auto-recall** — Before each conversation, Mimir searches your memory graph for context relevant to your current message. The results are injected as background knowledge your AI can draw from. You don't need to do anything — your AI simply "remembers."
**Auto-capture** — After each conversation, Mimir processes the dialogue and extracts:
- **Events & facts** — things you did, said, or decided, with timestamps
- **Entities** — people, projects, places, and concepts you mentioned
- **Relationships** — how entities connect to each other
- **Summaries** — condensed overviews of each conversation
All of this happens automatically. Your AI gets smarter with every conversation.
What Mimir Remembers
Mimir organizes your memories into six types:
**Events & Facts** — Atomic records with timestamps. "Arthur decided to use Go for the backend on March 1st." "Team agreed to freeze merges before the release."
**Entities** — People, projects, companies, tools, and concepts. Each has a name, type, and description that evolves as Mimir learns more.
**Relationships** — How entities connect. "Arthur works on Mimir." "Caroline designed the UI for the Chrome extension." These form a knowledge graph your AI can traverse.
**Episodes** — Summaries of past conversations. When you ask "what did we discuss last week?", Mimir pulls from these.
**Documents** — Files or long texts you've shared with your AI. Mimir indexes them for later retrieval.
**Foresights** — Plans, predictions, and future intentions. "Arthur plans to launch the beta next Thursday."
What You Can Do
Once installed, just talk to your AI naturally. No special commands needed.
**Just talk naturally:**
- "What did we discuss last week about the API?"
- "Who is Caroline?"
- "When did I decide to switch to TypeScript?"
- "Summarize our Chrome extension conversation"
- "What happened yesterday?"
- "What did I work on last month?"
- "What were my goals for this quarter?"
You don't need to do anything special. Your AI searches and retrieves context silently — from your perspective, it simply remembers.
Time Awareness
Every memory in Mimir is timestamped. Your AI understands time expressions in both English and Chinese:
- "yesterday" / "昨天"
- "last week" / "上周"
- "last month" / "上个月"
- "in March" / "三月份"
- "last summer" / "去年夏天"
When you ask a time-specific question, Mimir filters results to the relevant window. This means "what did I eat on Tuesday?" won't return results from three months ago.
Installation
Install Mimir from your dashboard in one message.
**Step 1: Get your API key**
Sign up at [allinmimir.com](https://www.allinmimir.com), open your [Dashboard](/dashboard), and generate an API key.
**Step 2: Send this to your AI**
Copy and paste this exact message to your AI assistant:
请阅读 https://api.allinmimir.com/SKILL.md 并帮我安装 Mimir 记忆插件。我的 API Key 是：sk-mimir-xxxsk-mimir-xxx with your actual API key. Your AI reads the SKILL.md guide, installs the plugin locally, and configures the environment for you.
**What happens under the hood:**
- AI runs npx memory-mimir@latest setup --api-key <YOUR_KEY>
- Plugin files and behavioral guide are installed locally
- After restarting the AI agent, memory is active
**Tip:** The [Dashboard](/dashboard) can generate the full install message with your key pre-filled, so the setup flow is simply: dashboard -> API key -> one message to your AI.Privacy & Security
**Your data is yours.**
- All memories are isolated per account — no cross-user leakage
- API keys use SHA-256 hashing; the raw key is shown only once at generation
- All communication is over HTTPS
- Mimir never shares your data with third parties
**API key safety:**
- Don't share your API key publicly or commit it to source code
- Rotate keys regularly from your [Dashboard](/dashboard)
- Revoke compromised keys immediately
Quick Start
**1.** Sign up at [allinmimir.com](https://www.allinmimir.com)
**2.** Open your [Dashboard](/dashboard) and generate an API key
**3.** Send this to your AI (replace with your real key):
请阅读 https://api.allinmimir.com/SKILL.md 并帮我安装 Mimir 记忆插件。我的 API Key 是：sk-mimir-xxxNeed help? Contact us at support@allinmimir.com