{"title":"Autenticação e Mind Keys","slug":"authentication","category":"getting-started","summary":"Como funciona a autenticação do Synapse: Mind Keys para agentes, JWTs para humanos, ?key= para ferramentas somente-URL.","audience":["human","llm"],"tags":["auth","mind-key","jwt","security"],"difficulty":"beginner","updated":"2026-06-27","word_count":531,"read_minutes":3,"llm_context":"Two auth methods: Mind Key (token-scoped, never expires) and JWT (user-scoped, 7-day expiry).\nMind Key: Authorization: Bearer mk_xxx OR ?key=mk_xxx (60 req/min limit on query)\nJWT: Authorization: Bearer eyJ... (no rate limit, used for /register, /login, /minds, /sharing)\nMind Key is shown only once at creation. Store it permanently.\nEach mind has exactly one Mind Key. Multiple minds = multiple keys.\n","lang":"pt","translated":true,"requested_lang":"pt","content_markdown":"\n# Autenticação e Mind Keys\n\nO Synapse usa dois métodos de autenticação, cada um otimizado para um caso de\nuso diferente. Entender a diferença é essencial para construir integrações\nconfiáveis.\n\n## Dois métodos de auth\n\n| Método | Caso de uso | Limite de taxa | Expiração |\n|--------|-------------|----------------|-----------|\n| **Mind Key** | Agentes LLM, ferramentas automatizadas | Nenhum (header) / 60 min (query) | Nunca |\n| **JWT** | Interface humana, operações de conta | Nenhum | 7 dias |\n\n## Mind Key (para agentes)\n\nUma Mind Key é um token de API com escopo de tenant. Ele autentica os dados de\num único mind (memórias, tarefas, chat, scripts, etc.). Use para:\n\n- Agentes LLM chamando a API\n- Scripts de automação em background\n- Configuração do servidor MCP\n- Qualquer integração de longa duração\n\n### Autenticação por cabeçalho (recomendada)\n\n```bash\ncurl -H \"Authorization: Bearer mk_yourMindKeyHere\" \\\n     https://synapse.schaefer.zone/memory/recall\n```\n\n### Parâmetro de consulta (para ferramentas somente-URL)\n\n```bash\ncurl https://synapse.schaefer.zone/memory/recall?key=mk_yourMindKeyHere\n```\n\n> [!WARNING]\n> O parâmetro de consulta `?key=` é limitado a **60 requisições por minuto**.\n> O cabeçalho Bearer não tem limite de taxa. Use o cabeçalho sempre que seu\n> cliente suportar cabeçalhos personalizados.\n\n### Criando uma Mind Key\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/minds \\\n  -H \"Authorization: Bearer YOUR_JWT\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"name\": \"Work Mind\", \"description\": \"Project memories\"}'\n```\n\nA resposta inclui `mind_key` — **salve-a imediatamente**, ela é exibida apenas\numa vez.\n\n### Listando seus minds\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_JWT\" \\\n     https://synapse.schaefer.zone/minds\n```\n\n### Excluindo um mind (irreversível!)\n\n```bash\ncurl -X DELETE -H \"Authorization: Bearer YOUR_JWT\" \\\n     https://synapse.schaefer.zone/minds/m_xyz789\n```\n\n## JWT (para humanos)\n\nJWTs autenticam a **conta do usuário**, não um mind específico. Use-os para:\n\n- Registro e login de conta\n- Criar / listar / excluir minds\n- Compartilhar minds com outros usuários\n- Gerenciamento de assinaturas Web Push\n\n### Registrar\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/register \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"email\": \"you@example.com\", \"password\": \"secret\"}'\n```\n\nRetorna: `{ \"jwt\": \"eyJ...\", \"user\": {...} }`\n\n### Login\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/login \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"email\": \"you@example.com\", \"password\": \"secret\"}'\n```\n\nRetorna: `{ \"jwt\": \"eyJ...\", \"user\": {...} }`\n\n### Expiração do JWT\n\nJWTs expiram após **7 dias**. Quando um JWT expira, basta chamar `/login`\nnovamente para obter um novo. A Mind Key nunca expira, então integrações de\nagentes existentes continuam funcionando.\n\n## Melhores práticas de segurança\n\n> [!CRITICAL]\n> - **Nunca faça commit de Mind Keys no git.** Use variáveis de ambiente.\n> - **Nunca registre Mind Keys em logs.** Mascarie-as em logs (`mk_***...***xyz`).\n> - **Faça rotação de keys** se suspeitar de vazamento (exclua o mind, crie um novo).\n> - **Use um mind por projeto** para limitar o raio de explosão se uma key vazar.\n\n### Padrão de variável de ambiente\n\n```bash\n# .env (NEVER commit this file)\nSYNAPSE_MIND_KEY=mk_yourMindKeyHere\nSYNAPSE_URL=https://synapse.schaefer.zone\n```\n\n```typescript\n// Node.js\nconst mindKey = process.env.SYNAPSE_MIND_KEY;\nconst url = process.env.SYNAPSE_URL;\nawait fetch(`${url}/memory/recall`, {\n  headers: { Authorization: `Bearer ${mindKey}` },\n});\n```\n\n### Configuração do servidor MCP\n\n```json\n{\n  \"mcpServers\": {\n    \"synapse\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"synapse-mcp-api@latest\"],\n      \"env\": {\n        \"SYNAPSE_MIND_KEY\": \"mk_yourMindKeyHere\",\n        \"SYNAPSE_URL\": \"https://synapse.schaefer.zone\"\n      }\n    }\n  }\n}\n```\n\n## Padrão multi-mind\n\nCada usuário pode ter múltiplos minds. Padrões comuns:\n\n| Nome do mind | Finalidade |\n|--------------|------------|\n| `work` | Memórias relacionadas ao trabalho |\n| `personal` | Preferências pessoais, família |\n| `project-synapse` | Contexto de projeto específico |\n| `learning-german` | Progresso de aprendizado |\n| `assistant-default` | Fallback de propósito geral |\n\nUse Mind Keys diferentes para sessões LLM diferentes para manter contextos\nisolados.\n\n## Limites de taxa\n\n| Método de auth | Limite | Escopo |\n|----------------|--------|--------|\n| Mind Key (header) | Nenhum | Por mind |\n| Mind Key (?key=) | 60/min | Por IP |\n| JWT (header) | Nenhum | Por usuário |\n| Endpoints públicos | Nenhum | Global |\n\nCabeçalhos de limite de taxa (`X-RateLimit-Limit`, `X-RateLimit-Remaining`,\n`Retry-After`) são incluídos nas respostas quando aplicável.\n\n## Próximos passos\n\n- [Mind Key vs JWT](/docs/getting-started/mind-key-vs-jwt) — quando usar qual\n- [API de Memória](/docs/api/memory) — o que você pode fazer com uma Mind Key\n- [API de Usuário](/docs/api/user) — gerenciamento de conta com JWTs\n","content_html":"<h1>Autenticação e Mind Keys</h1>\n<p>O Synapse usa dois métodos de autenticação, cada um otimizado para um caso de\nuso diferente. Entender a diferença é essencial para construir integrações\nconfiáveis.</p>\n<h2>Dois métodos de auth</h2>\n<table>\n<thead>\n<tr>\n<th>Método</th>\n<th>Caso de uso</th>\n<th>Limite de taxa</th>\n<th>Expiração</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><strong>Mind Key</strong></td>\n<td>Agentes LLM, ferramentas automatizadas</td>\n<td>Nenhum (header) / 60 min (query)</td>\n<td>Nunca</td>\n</tr>\n<tr>\n<td><strong>JWT</strong></td>\n<td>Interface humana, operações de conta</td>\n<td>Nenhum</td>\n<td>7 dias</td>\n</tr>\n</tbody></table>\n<h2>Mind Key (para agentes)</h2>\n<p>Uma Mind Key é um token de API com escopo de tenant. Ele autentica os dados de\num único mind (memórias, tarefas, chat, scripts, etc.). Use para:</p>\n<ul>\n<li>Agentes LLM chamando a API</li>\n<li>Scripts de automação em background</li>\n<li>Configuração do servidor MCP</li>\n<li>Qualquer integração de longa duração</li>\n</ul>\n<h3>Autenticação por cabeçalho (recomendada)</h3>\n<pre><code class=\"hljs language-bash\">curl -H <span class=\"hljs-string\">&quot;Authorization: Bearer mk_yourMindKeyHere&quot;</span> \\\n     https://synapse.schaefer.zone/memory/recall</code></pre><h3>Parâmetro de consulta (para ferramentas somente-URL)</h3>\n<pre><code class=\"hljs language-bash\">curl https://synapse.schaefer.zone/memory/recall?key=mk_yourMindKeyHere</code></pre><div class=\"callout callout-warn\">O parâmetro de consulta `?key=` é limitado a **60 requisições por minuto**.\nO cabeçalho Bearer não tem limite de taxa. Use o cabeçalho sempre que seu\ncliente suportar cabeçalhos personalizados.</div><h3>Criando uma Mind Key</h3>\n<pre><code class=\"hljs language-bash\">curl -X POST https://synapse.schaefer.zone/minds \\\n  -H <span class=\"hljs-string\">&quot;Authorization: Bearer YOUR_JWT&quot;</span> \\\n  -H <span class=\"hljs-string\">&quot;Content-Type: application/json&quot;</span> \\\n  -d <span class=\"hljs-string\">&#x27;{&quot;name&quot;: &quot;Work Mind&quot;, &quot;description&quot;: &quot;Project memories&quot;}&#x27;</span></code></pre><p>A resposta inclui <code>mind_key</code> — <strong>salve-a imediatamente</strong>, ela é exibida apenas\numa vez.</p>\n<h3>Listando seus minds</h3>\n<pre><code class=\"hljs language-bash\">curl -H <span class=\"hljs-string\">&quot;Authorization: Bearer YOUR_JWT&quot;</span> \\\n     https://synapse.schaefer.zone/minds</code></pre><h3>Excluindo um mind (irreversível!)</h3>\n<pre><code class=\"hljs language-bash\">curl -X DELETE -H <span class=\"hljs-string\">&quot;Authorization: Bearer YOUR_JWT&quot;</span> \\\n     https://synapse.schaefer.zone/minds/m_xyz789</code></pre><h2>JWT (para humanos)</h2>\n<p>JWTs autenticam a <strong>conta do usuário</strong>, não um mind específico. Use-os para:</p>\n<ul>\n<li>Registro e login de conta</li>\n<li>Criar / listar / excluir minds</li>\n<li>Compartilhar minds com outros usuários</li>\n<li>Gerenciamento de assinaturas Web Push</li>\n</ul>\n<h3>Registrar</h3>\n<pre><code class=\"hljs language-bash\">curl -X POST https://synapse.schaefer.zone/register \\\n  -H <span class=\"hljs-string\">&quot;Content-Type: application/json&quot;</span> \\\n  -d <span class=\"hljs-string\">&#x27;{&quot;email&quot;: &quot;you@example.com&quot;, &quot;password&quot;: &quot;secret&quot;}&#x27;</span></code></pre><p>Retorna: <code>{ &quot;jwt&quot;: &quot;eyJ...&quot;, &quot;user&quot;: {...} }</code></p>\n<h3>Login</h3>\n<pre><code class=\"hljs language-bash\">curl -X POST https://synapse.schaefer.zone/login \\\n  -H <span class=\"hljs-string\">&quot;Content-Type: application/json&quot;</span> \\\n  -d <span class=\"hljs-string\">&#x27;{&quot;email&quot;: &quot;you@example.com&quot;, &quot;password&quot;: &quot;secret&quot;}&#x27;</span></code></pre><p>Retorna: <code>{ &quot;jwt&quot;: &quot;eyJ...&quot;, &quot;user&quot;: {...} }</code></p>\n<h3>Expiração do JWT</h3>\n<p>JWTs expiram após <strong>7 dias</strong>. Quando um JWT expira, basta chamar <code>/login</code>\nnovamente para obter um novo. A Mind Key nunca expira, então integrações de\nagentes existentes continuam funcionando.</p>\n<h2>Melhores práticas de segurança</h2>\n<div class=\"callout callout-critical\"></div><h3>Padrão de variável de ambiente</h3>\n<pre><code class=\"hljs language-bash\"><span class=\"hljs-comment\"># .env (NEVER commit this file)</span>\nSYNAPSE_MIND_KEY=mk_yourMindKeyHere\nSYNAPSE_URL=https://synapse.schaefer.zone</code></pre><pre><code class=\"hljs language-typescript\"><span class=\"hljs-comment\">// Node.js</span>\n<span class=\"hljs-keyword\">const</span> mindKey = process.<span class=\"hljs-property\">env</span>.<span class=\"hljs-property\">SYNAPSE_MIND_KEY</span>;\n<span class=\"hljs-keyword\">const</span> url = process.<span class=\"hljs-property\">env</span>.<span class=\"hljs-property\">SYNAPSE_URL</span>;\n<span class=\"hljs-keyword\">await</span> <span class=\"hljs-title function_\">fetch</span>(<span class=\"hljs-string\">`<span class=\"hljs-subst\">${url}</span>/memory/recall`</span>, {\n  <span class=\"hljs-attr\">headers</span>: { <span class=\"hljs-title class_\">Authorization</span>: <span class=\"hljs-string\">`Bearer <span class=\"hljs-subst\">${mindKey}</span>`</span> },\n});</code></pre><h3>Configuração do servidor MCP</h3>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n  <span class=\"hljs-attr\">&quot;mcpServers&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">{</span>\n    <span class=\"hljs-attr\">&quot;synapse&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">{</span>\n      <span class=\"hljs-attr\">&quot;command&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;npx&quot;</span><span class=\"hljs-punctuation\">,</span>\n      <span class=\"hljs-attr\">&quot;args&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-string\">&quot;-y&quot;</span><span class=\"hljs-punctuation\">,</span> <span class=\"hljs-string\">&quot;synapse-mcp-api@latest&quot;</span><span class=\"hljs-punctuation\">]</span><span class=\"hljs-punctuation\">,</span>\n      <span class=\"hljs-attr\">&quot;env&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">{</span>\n        <span class=\"hljs-attr\">&quot;SYNAPSE_MIND_KEY&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;mk_yourMindKeyHere&quot;</span><span class=\"hljs-punctuation\">,</span>\n        <span class=\"hljs-attr\">&quot;SYNAPSE_URL&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;https://synapse.schaefer.zone&quot;</span>\n      <span class=\"hljs-punctuation\">}</span>\n    <span class=\"hljs-punctuation\">}</span>\n  <span class=\"hljs-punctuation\">}</span>\n<span class=\"hljs-punctuation\">}</span></code></pre><h2>Padrão multi-mind</h2>\n<p>Cada usuário pode ter múltiplos minds. Padrões comuns:</p>\n<table>\n<thead>\n<tr>\n<th>Nome do mind</th>\n<th>Finalidade</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>work</code></td>\n<td>Memórias relacionadas ao trabalho</td>\n</tr>\n<tr>\n<td><code>personal</code></td>\n<td>Preferências pessoais, família</td>\n</tr>\n<tr>\n<td><code>project-synapse</code></td>\n<td>Contexto de projeto específico</td>\n</tr>\n<tr>\n<td><code>learning-german</code></td>\n<td>Progresso de aprendizado</td>\n</tr>\n<tr>\n<td><code>assistant-default</code></td>\n<td>Fallback de propósito geral</td>\n</tr>\n</tbody></table>\n<p>Use Mind Keys diferentes para sessões LLM diferentes para manter contextos\nisolados.</p>\n<h2>Limites de taxa</h2>\n<table>\n<thead>\n<tr>\n<th>Método de auth</th>\n<th>Limite</th>\n<th>Escopo</th>\n</tr>\n</thead>\n<tbody><tr>\n<td>Mind Key (header)</td>\n<td>Nenhum</td>\n<td>Por mind</td>\n</tr>\n<tr>\n<td>Mind Key (?key=)</td>\n<td>60/min</td>\n<td>Por IP</td>\n</tr>\n<tr>\n<td>JWT (header)</td>\n<td>Nenhum</td>\n<td>Por usuário</td>\n</tr>\n<tr>\n<td>Endpoints públicos</td>\n<td>Nenhum</td>\n<td>Global</td>\n</tr>\n</tbody></table>\n<p>Cabeçalhos de limite de taxa (<code>X-RateLimit-Limit</code>, <code>X-RateLimit-Remaining</code>,\n<code>Retry-After</code>) são incluídos nas respostas quando aplicável.</p>\n<h2>Próximos passos</h2>\n<ul>\n<li><a href=\"/docs/getting-started/mind-key-vs-jwt\">Mind Key vs JWT</a> — quando usar qual</li>\n<li><a href=\"/docs/api/memory\">API de Memória</a> — o que você pode fazer com uma Mind Key</li>\n<li><a href=\"/docs/api/user\">API de Usuário</a> — gerenciamento de conta com JWTs</li>\n</ul>\n","urls":{"html":"/docs/getting-started/authentication","text":"/docs/getting-started/authentication?format=text","json":"/docs/getting-started/authentication?format=json","llm":"/docs/getting-started/authentication?format=llm"},"translations_available":["en","zh","hi","es","fr","ar","pt","ru","ja","de","it","ko","nl","pl","tr","sv","vi","th","id","uk"]}