{"title":"Erros e tratamento de erros","slug":"errors","category":"api","summary":"Códigos de status HTTP, formato de resposta de erro e como se recuperar de erros comuns.","audience":["human","llm"],"tags":["api","errors","troubleshooting","http"],"difficulty":"beginner","updated":"2026-06-27","word_count":553,"read_minutes":3,"llm_context":"Error format: { statusCode, error, message, docs? }\nCommon errors: 401 (auth), 404 (wrong path), 429 (rate limit), 500 (server)\n401 → check Mind Key/JWT, see /docs/getting-started/authentication\n404 → wrong path, GET /endpoints for valid list, do NOT guess paths\n429 → rate limited (?key= is 60/min), use Bearer header instead\n500 → server error, retry with backoff, check /health\ndocs field in error response links to relevant documentation.\n","lang":"pt","translated":true,"requested_lang":"pt","content_markdown":"\n# Erros e tratamento de erros\n\nO Synapse usa códigos de status HTTP padrão com um formato consistente de\nresposta de erro. Esta página explica como interpretar e se recuperar de erros.\n\n## Formato de resposta de erro\n\nTodos os erros retornam JSON com esta estrutura:\n\n```json\n{\n  \"statusCode\": 401,\n  \"error\": \"Unauthorized\",\n  \"message\": \"Mind Key fehlt oder ungültig.\",\n  \"docs\": \"https://synapse.schaefer.zone/docs/getting-started/authentication\"\n}\n```\n\n| Campo | Descrição |\n|-------|-----------|\n| `statusCode` | Código de status HTTP |\n| `error` | Nome do status HTTP |\n| `message` | Descrição do erro legível para humanos |\n| `docs` | URL para a documentação relevante (quando aplicável) |\n\n## Códigos de status HTTP\n\n### 200 OK\n\nSucesso. A requisição foi processada corretamente.\n\n### 201 Created\n\nSucesso. Um novo recurso foi criado (ex.: `POST /memory`).\n\n### 204 No Content\n\nSucesso. Sem corpo retornado (ex.: `DELETE /memory/:id`).\n\n### 400 Bad Request\n\nA requisição estava malformada. Causas comuns:\n\n- Campos JSON obrigatórios ausentes\n- Sintaxe JSON inválida\n- Valor de enum inválido (ex.: categoria errada)\n\n```json\n{\n  \"statusCode\": 400,\n  \"error\": \"Bad Request\",\n  \"message\": \"category must be one of: identity, preference, fact, project, skill, mistake, context, note, credentials\"\n}\n```\n\n**Correção:** Confira o corpo da requisição com a documentação da API. Garanta\nque todos os campos obrigatórios estão presentes e têm valores válidos.\n\n### 401 Unauthorized\n\nA autenticação falhou. Causas comuns:\n\n- Cabeçalho `Authorization` ausente\n- Mind Key ou JWT inválido\n- Uso de Mind Key onde JWT é necessário (ou vice-versa)\n\n```json\n{\n  \"statusCode\": 401,\n  \"error\": \"Unauthorized\",\n  \"message\": \"Mind Key fehlt oder ungültig.\",\n  \"docs\": \"https://synapse.schaefer.zone/docs/getting-started/authentication\"\n}\n```\n\n**Correção:** Verifique seu token. Consulte [Autenticação](/docs/getting-started/authentication).\n\n### 403 Forbidden\n\nVocê está autenticado, mas não tem permissão para realizar esta ação. Causas\ncomuns:\n\n- Tentativa de excluir o mind de outro usuário\n- Tentativa de verificar uma memória com Mind Key (requer JWT)\n- Mind desativado\n\n**Correção:** Verifique se você está usando o tipo correto de token para este\nendpoint.\n\n### 404 Not Found\n\nO caminho ou recurso solicitado não existe.\n\n> [!CRITICAL]\n> **NÃO tente adivinhar caminhos de endpoint.** Apenas os caminhos listados em\n> `GET /endpoints` existem. Se você recebeu um 404, usou um caminho errado.\n\n```json\n{\n  \"statusCode\": 404,\n  \"error\": \"Not Found\",\n  \"message\": \"Route GET /memory/list not found\",\n  \"docs\": \"https://synapse.schaefer.zone/docs/api/errors\"\n}\n```\n\n**Correção:** Chame `GET /endpoints` para ver a lista de endpoints válidos.\nCompare sua URL com a lista caractere por caractere.\n\n### 409 Conflict\n\nA requisição conflita com o estado existente. Causas comuns:\n\n- Tentativa de registrar com um email que já existe\n- URL de webhook duplicada\n\n**Correção:** Use um valor diferente, ou use `PUT` para atualizar o recurso\nexistente.\n\n### 429 Too Many Requests\n\nVocê atingiu um limite de taxa. Aplica-se apenas à auth via parâmetro de\nconsulta `?key=` (60/min).\n\n```json\n{\n  \"statusCode\": 429,\n  \"error\": \"Too Many Requests\",\n  \"message\": \"Rate limit exceeded. Use Authorization header for unlimited access.\"\n}\n```\n\nCabeçalhos da resposta:\n\n```\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 0\nRetry-After: 42\n```\n\n**Correção:** Mude para o cabeçalho `Authorization: Bearer` (sem limite de\ntaxa), ou aguarde `Retry-After` segundos.\n\n### 500 Internal Server Error\n\nErro de servidor. Isso não deveria acontecer — se acontecer, é um bug.\n\n**Correção:**\n\n1. Faça retry com backoff exponencial (1s, 2s, 4s, 8s)\n2. Verifique `GET /health` para ver se o servidor está no ar\n3. Se persistir, relate o erro\n\n### 503 Service Unavailable\n\nServidor temporariamente indisponível (ex.: durante deploy, migração de banco).\n\n**Correção:** Aguarde e tente novamente. Verifique `GET /health`.\n\n## Padrões de recuperação\n\n### Retry com backoff exponencial\n\n```python\nimport time\nimport requests\n\ndef call_with_retry(url, max_retries=3):\n    for attempt in range(max_retries):\n        try:\n            r = requests.get(url, headers={\"Authorization\": f\"Bearer {KEY}\"})\n            if r.status_code == 429:\n                wait = int(r.headers.get(\"Retry-After\", 60))\n                time.sleep(wait)\n                continue\n            if r.status_code >= 500:\n                time.sleep(2 ** attempt)\n                continue\n            return r\n        except requests.RequestException:\n            time.sleep(2 ** attempt)\n    raise Exception(f\"Failed after {max_retries} retries\")\n```\n\n### Tratamento de erro de auth\n\n```python\ndef safe_call(url, key):\n    r = requests.get(url, headers={\"Authorization\": f\"Bearer {key}\"})\n    if r.status_code == 401:\n        # Mind Key invalid — alert user\n        raise AuthError(\"Mind Key invalid or expired\")\n    return r\n```\n\n## Cenários comuns de erro\n\n### \"Mind Key fehlt oder ungültig\"\n\n- Você esqueceu o cabeçalho `Authorization`\n- Você usou `?key=` mas a chave está errada\n- Você está usando um JWT onde uma Mind Key é necessária\n\n### \"Route not found\"\n\n- Você tentou adivinhar um caminho que não existe\n- Você usou um verbo errado (ex.: `GET /memory` vs `POST /memory`)\n- Confira `GET /endpoints` para caminhos válidos\n\n### \"Rate limit exceeded\"\n\n- Você está usando `?key=` e excedeu 60 req/min\n- Mude para o cabeçalho `Authorization: Bearer`\n\n## Próximos passos\n\n- [Autenticação](/docs/getting-started/authentication)\n- [Visão geral da API](/docs/api/overview)\n- [Limites de taxa](/docs/api/rate-limits)\n","content_html":"<h1>Erros e tratamento de erros</h1>\n<p>O Synapse usa códigos de status HTTP padrão com um formato consistente de\nresposta de erro. Esta página explica como interpretar e se recuperar de erros.</p>\n<h2>Formato de resposta de erro</h2>\n<p>Todos os erros retornam JSON com esta estrutura:</p>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n  <span class=\"hljs-attr\">&quot;statusCode&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">401</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;error&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Unauthorized&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;message&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Mind Key fehlt oder ungültig.&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;docs&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;https://synapse.schaefer.zone/docs/getting-started/authentication&quot;</span>\n<span class=\"hljs-punctuation\">}</span></code></pre><table>\n<thead>\n<tr>\n<th>Campo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody><tr>\n<td><code>statusCode</code></td>\n<td>Código de status HTTP</td>\n</tr>\n<tr>\n<td><code>error</code></td>\n<td>Nome do status HTTP</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Descrição do erro legível para humanos</td>\n</tr>\n<tr>\n<td><code>docs</code></td>\n<td>URL para a documentação relevante (quando aplicável)</td>\n</tr>\n</tbody></table>\n<h2>Códigos de status HTTP</h2>\n<h3>200 OK</h3>\n<p>Sucesso. A requisição foi processada corretamente.</p>\n<h3>201 Created</h3>\n<p>Sucesso. Um novo recurso foi criado (ex.: <code>POST /memory</code>).</p>\n<h3>204 No Content</h3>\n<p>Sucesso. Sem corpo retornado (ex.: <code>DELETE /memory/:id</code>).</p>\n<h3>400 Bad Request</h3>\n<p>A requisição estava malformada. Causas comuns:</p>\n<ul>\n<li>Campos JSON obrigatórios ausentes</li>\n<li>Sintaxe JSON inválida</li>\n<li>Valor de enum inválido (ex.: categoria errada)</li>\n</ul>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n  <span class=\"hljs-attr\">&quot;statusCode&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">400</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;error&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Bad Request&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;message&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;category must be one of: identity, preference, fact, project, skill, mistake, context, note, credentials&quot;</span>\n<span class=\"hljs-punctuation\">}</span></code></pre><p><strong>Correção:</strong> Confira o corpo da requisição com a documentação da API. Garanta\nque todos os campos obrigatórios estão presentes e têm valores válidos.</p>\n<h3>401 Unauthorized</h3>\n<p>A autenticação falhou. Causas comuns:</p>\n<ul>\n<li>Cabeçalho <code>Authorization</code> ausente</li>\n<li>Mind Key ou JWT inválido</li>\n<li>Uso de Mind Key onde JWT é necessário (ou vice-versa)</li>\n</ul>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n  <span class=\"hljs-attr\">&quot;statusCode&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">401</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;error&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Unauthorized&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;message&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Mind Key fehlt oder ungültig.&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;docs&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;https://synapse.schaefer.zone/docs/getting-started/authentication&quot;</span>\n<span class=\"hljs-punctuation\">}</span></code></pre><p><strong>Correção:</strong> Verifique seu token. Consulte <a href=\"/docs/getting-started/authentication\">Autenticação</a>.</p>\n<h3>403 Forbidden</h3>\n<p>Você está autenticado, mas não tem permissão para realizar esta ação. Causas\ncomuns:</p>\n<ul>\n<li>Tentativa de excluir o mind de outro usuário</li>\n<li>Tentativa de verificar uma memória com Mind Key (requer JWT)</li>\n<li>Mind desativado</li>\n</ul>\n<p><strong>Correção:</strong> Verifique se você está usando o tipo correto de token para este\nendpoint.</p>\n<h3>404 Not Found</h3>\n<p>O caminho ou recurso solicitado não existe.</p>\n<div class=\"callout callout-critical\">**NÃO tente adivinhar caminhos de endpoint.** Apenas os caminhos listados em\n`GET /endpoints` existem. Se você recebeu um 404, usou um caminho errado.</div><pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n  <span class=\"hljs-attr\">&quot;statusCode&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">404</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;error&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Not Found&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;message&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Route GET /memory/list not found&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;docs&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;https://synapse.schaefer.zone/docs/api/errors&quot;</span>\n<span class=\"hljs-punctuation\">}</span></code></pre><p><strong>Correção:</strong> Chame <code>GET /endpoints</code> para ver a lista de endpoints válidos.\nCompare sua URL com a lista caractere por caractere.</p>\n<h3>409 Conflict</h3>\n<p>A requisição conflita com o estado existente. Causas comuns:</p>\n<ul>\n<li>Tentativa de registrar com um email que já existe</li>\n<li>URL de webhook duplicada</li>\n</ul>\n<p><strong>Correção:</strong> Use um valor diferente, ou use <code>PUT</code> para atualizar o recurso\nexistente.</p>\n<h3>429 Too Many Requests</h3>\n<p>Você atingiu um limite de taxa. Aplica-se apenas à auth via parâmetro de\nconsulta <code>?key=</code> (60/min).</p>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n  <span class=\"hljs-attr\">&quot;statusCode&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">429</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;error&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Too Many Requests&quot;</span><span class=\"hljs-punctuation\">,</span>\n  <span class=\"hljs-attr\">&quot;message&quot;</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">&quot;Rate limit exceeded. Use Authorization header for unlimited access.&quot;</span>\n<span class=\"hljs-punctuation\">}</span></code></pre><p>Cabeçalhos da resposta:</p>\n<pre><code class=\"hljs language-plaintext\">X-RateLimit-Limit: 60\nX-RateLimit-Remaining: 0\nRetry-After: 42</code></pre><p><strong>Correção:</strong> Mude para o cabeçalho <code>Authorization: Bearer</code> (sem limite de\ntaxa), ou aguarde <code>Retry-After</code> segundos.</p>\n<h3>500 Internal Server Error</h3>\n<p>Erro de servidor. Isso não deveria acontecer — se acontecer, é um bug.</p>\n<p><strong>Correção:</strong></p>\n<ol>\n<li>Faça retry com backoff exponencial (1s, 2s, 4s, 8s)</li>\n<li>Verifique <code>GET /health</code> para ver se o servidor está no ar</li>\n<li>Se persistir, relate o erro</li>\n</ol>\n<h3>503 Service Unavailable</h3>\n<p>Servidor temporariamente indisponível (ex.: durante deploy, migração de banco).</p>\n<p><strong>Correção:</strong> Aguarde e tente novamente. Verifique <code>GET /health</code>.</p>\n<h2>Padrões de recuperação</h2>\n<h3>Retry com backoff exponencial</h3>\n<pre><code class=\"hljs language-python\"><span class=\"hljs-keyword\">import</span> time\n<span class=\"hljs-keyword\">import</span> requests\n\n<span class=\"hljs-keyword\">def</span> <span class=\"hljs-title function_\">call_with_retry</span>(<span class=\"hljs-params\">url, max_retries=<span class=\"hljs-number\">3</span></span>):\n    <span class=\"hljs-keyword\">for</span> attempt <span class=\"hljs-keyword\">in</span> <span class=\"hljs-built_in\">range</span>(max_retries):\n        <span class=\"hljs-keyword\">try</span>:\n            r = requests.get(url, headers={<span class=\"hljs-string\">&quot;Authorization&quot;</span>: <span class=\"hljs-string\">f&quot;Bearer <span class=\"hljs-subst\">{KEY}</span>&quot;</span>})\n            <span class=\"hljs-keyword\">if</span> r.status_code == <span class=\"hljs-number\">429</span>:\n                wait = <span class=\"hljs-built_in\">int</span>(r.headers.get(<span class=\"hljs-string\">&quot;Retry-After&quot;</span>, <span class=\"hljs-number\">60</span>))\n                time.sleep(wait)\n                <span class=\"hljs-keyword\">continue</span>\n            <span class=\"hljs-keyword\">if</span> r.status_code &gt;= <span class=\"hljs-number\">500</span>:\n                time.sleep(<span class=\"hljs-number\">2</span> ** attempt)\n                <span class=\"hljs-keyword\">continue</span>\n            <span class=\"hljs-keyword\">return</span> r\n        <span class=\"hljs-keyword\">except</span> requests.RequestException:\n            time.sleep(<span class=\"hljs-number\">2</span> ** attempt)\n    <span class=\"hljs-keyword\">raise</span> Exception(<span class=\"hljs-string\">f&quot;Failed after <span class=\"hljs-subst\">{max_retries}</span> retries&quot;</span>)</code></pre><h3>Tratamento de erro de auth</h3>\n<pre><code class=\"hljs language-python\"><span class=\"hljs-keyword\">def</span> <span class=\"hljs-title function_\">safe_call</span>(<span class=\"hljs-params\">url, key</span>):\n    r = requests.get(url, headers={<span class=\"hljs-string\">&quot;Authorization&quot;</span>: <span class=\"hljs-string\">f&quot;Bearer <span class=\"hljs-subst\">{key}</span>&quot;</span>})\n    <span class=\"hljs-keyword\">if</span> r.status_code == <span class=\"hljs-number\">401</span>:\n        <span class=\"hljs-comment\"># Mind Key invalid — alert user</span>\n        <span class=\"hljs-keyword\">raise</span> AuthError(<span class=\"hljs-string\">&quot;Mind Key invalid or expired&quot;</span>)\n    <span class=\"hljs-keyword\">return</span> r</code></pre><h2>Cenários comuns de erro</h2>\n<h3>&quot;Mind Key fehlt oder ungültig&quot;</h3>\n<ul>\n<li>Você esqueceu o cabeçalho <code>Authorization</code></li>\n<li>Você usou <code>?key=</code> mas a chave está errada</li>\n<li>Você está usando um JWT onde uma Mind Key é necessária</li>\n</ul>\n<h3>&quot;Route not found&quot;</h3>\n<ul>\n<li>Você tentou adivinhar um caminho que não existe</li>\n<li>Você usou um verbo errado (ex.: <code>GET /memory</code> vs <code>POST /memory</code>)</li>\n<li>Confira <code>GET /endpoints</code> para caminhos válidos</li>\n</ul>\n<h3>&quot;Rate limit exceeded&quot;</h3>\n<ul>\n<li>Você está usando <code>?key=</code> e excedeu 60 req/min</li>\n<li>Mude para o cabeçalho <code>Authorization: Bearer</code></li>\n</ul>\n<h2>Próximos passos</h2>\n<ul>\n<li><a href=\"/docs/getting-started/authentication\">Autenticação</a></li>\n<li><a href=\"/docs/api/overview\">Visão geral da API</a></li>\n<li><a href=\"/docs/api/rate-limits\">Limites de taxa</a></li>\n</ul>\n","urls":{"html":"/docs/api/errors","text":"/docs/api/errors?format=text","json":"/docs/api/errors?format=json","llm":"/docs/api/errors?format=llm"},"translations_available":["en","zh","hi","es","fr","ar","pt","ru","ja","de","it","ko","nl","pl","tr","sv","vi","th","id","uk"]}