> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maximem.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Maximem Synap is a managed memory layer for AI agents: it ingests conversations and documents, extracts structured memory, and returns scoped context to the agent at retrieval time.
> The Python and JavaScript/TypeScript SDKs are the supported way to use Synap. Write integration code with SDK calls, not raw HTTP requests.
> Start with the Quickstart: https://docs.maximem.ai/getting-started/quickstart.md. Every SDK method is documented in the SDK reference: https://docs.maximem.ai/sdk-reference/overview.md.

# Quickstart

> Connect Vity to OpenClaw, Hermes, an MCP client or your browser, then check that it remembers.

Pick the tool you want memory in, set it up, and check that it remembers. It takes a few minutes. You can add more tools later: your API keys and your browser sign-in all belong to one Vity account, so every tool you connect reads and writes the same memory.

## Get a Vity API key

OpenClaw, Hermes and MCP clients connect to Vity with an API key. The browser extension does not need one, because you sign in to it with Google; if that is the only tool you want, skip to the **Browser** tab below.

**1. Sign in to the Vity dashboard**

Go to [app.maximem.ai](https://app.maximem.ai) and sign in with Google.

**2. Generate a key**

On a new account, Vity first asks how you will use your memory. Choose **Give your AI agent long-term memory**, enter a name for the key, and click **Generate**.

If you have already been through that, open **API Keys** in the sidebar, click **Generate API Key**, enter a name, and click **Generate Key**.

**3. Copy the key now**

The key starts with `mx_`. Vity shows it only once, so copy it before you close the dialog. If you lose it, revoke it on the **API Keys** page and generate a new one.

> [!WARNING]
>
> Anyone with this key can read and write your memory. Put it only where the steps below say: an installer prompt, a config file, or your MCP client's header settings. Never paste it into a conversation with an AI.

Your first API key also adds 10,000 credits to your account, which Vity uses up as your tools save and recall memories.

Use a Vity key, not a Synap key. Synap keys start with `synap_` and Vity rejects them; see [Vity or Synap?](/vity/vity-vs-synap) for why.

## Connect your tool

**OpenClaw**

Install the plugin:

```bash theme={null}
openclaw plugins install @maximem/memory-plugin
```

Then give it your key. Either set the `MAXIMEM_API_KEY` environment variable in your shell profile, or put the key in the plugin's `apiKey` setting in `~/.openclaw/openclaw.json`. [OpenClaw configuration](/vity/openclaw#configuration) has the exact lines for zsh, bash and PowerShell.

Then restart OpenClaw (from a new terminal, if you used the environment variable). The plugin reads the key only when OpenClaw starts, and switches itself off if it finds none.

**Check that it works.** In any OpenClaw chat, save something and ask for it back:

```
/remember I prefer short answers with the code first
/recall short answers
```

`/remember` replies `Stored in memory:` followed by what you saved. `/recall` replies with the memories it found, each with a relevance score.

From then on, the plugin recalls relevant memories before each turn and saves new context after it, with no commands. See [OpenClaw](/vity/openclaw) for the agent tools, CLI and settings.

**Hermes**

Install the package, then run its installer:

```bash theme={null}
pip install hermes-maximem-vity
hermes-maximem-vity install
```

The installer copies the plugin into Hermes, asks you to paste your key (it saves it to `~/.hermes/.env`), and makes Vity Hermes' memory provider. When it prints **All set! Vity memory is active.**, start Hermes with `hermes`. If Hermes was already running, restart it so it loads the new provider.

If `pip` refuses with an "externally-managed-environment" error, install with `pipx` instead; [Hermes installation](/vity/hermes#installation) explains how.

**Check that it works.** First confirm the connection:

```bash theme={null}
hermes maximem_vity status
```

It should show your API key as set, the SDK as installed, and the connection as ok. Then save a memory and search for it:

```bash theme={null}
hermes maximem_vity store "I prefer short answers with the code first" --type preference
hermes maximem_vity search "short answers"
```

In normal use you don't need these commands: Hermes recalls relevant memories before each turn and saves the conversation after it. See [Hermes Agent](/vity/hermes) for the agent tools and settings.

**MCP client**

Add the Vity MCP server to your client with this URL, and your key in an `Authorization` header:

| | |
| - | - |
| **URL** | `https://vity-mcp.maximem.ai/mcp` |
| **Header** | `Authorization: Bearer mx_...` |

In Claude Code, that is one command:

```bash theme={null}
claude mcp add --transport http vity https://vity-mcp.maximem.ai/mcp \
  --header "Authorization: Bearer mx_..."
```

For Cursor and other clients, see [Connect your client](/vity/mcp/overview#connect-your-client). The server reads your key from that header and has no other way to sign in, so your client must let you set a request header; see [Client compatibility](/vity/mcp/overview#client-compatibility).

**Check that it works.** In Claude Code, run `claude mcp list` and look for `vity` as connected. Then ask your agent:

```
What do you know about me?
```

It should call one of Vity's recall tools, such as `recall_context`, and answer from your memory. A new account starts empty, so "nothing yet" still means the connection works. Anything you saved through OpenClaw, Hermes or the browser extension on the same account shows up here.

Don't use the `remember` tool as your first test: it does not save to your memory directly, so what it records won't show up in recall straight away.

See [Set up the MCP server](/vity/mcp/overview) for the full setup and [Tools and prompts](/vity/mcp/tools) for everything your agent can call.

**Browser**

**1. Install the extension**

Install **Maximem Vity** from the [Chrome Web Store](https://chromewebstore.google.com/detail/pnoblhifdakihlkclbbdpialcoiinmfi).

**2. Sign in**

Open the extension from your browser toolbar and click **Sign in and open dashboard**. Sign in with the Google account you use for app.maximem.ai. The extension does not use an API key.

**Check that it works.** Open the extension again. Instead of the sign-in screen, it now shows your vault. A new account shows **Your vault is empty**, with an **Import chats from dashboard** button to bring in your past AI chats.

The extension works on AI sites such as ChatGPT, Claude, Gemini and Perplexity. See [Browser extension](/vity/browser-extension) for the full list of sites, what it does on each, and how to turn saving off.

## Next steps

> **[Vity or Synap?](/vity/vity-vs-synap)**
>
> Check that Vity is the right product, and which dashboard and key go with it.

> **[Configuration](/vity/configuration)**
>
> Change what Vity recalls and captures, and manage your keys.

> **[Privacy and data](/vity/privacy)**
>
> What Vity stores and how to delete it.

> **[Overview](/vity/overview)**
>
> What Vity does and where it works.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.