# Visão geral da API e URL base SUMMARY: Todos os endpoints da API do Synapse, URL base, padrões de autenticação e formatos de resposta em um só lugar. KEY CONTEXT: Base URL: https://synapse.schaefer.zone Auth: Authorization: Bearer YOUR_MIND_KEY (header, no rate limit) OR ?key=YOUR_MIND_KEY (query, 60 req/min) All responses are JSON except /memory/recall (text/plain) and /docs (HTML/text/json) All 404 responses mean the path does not exist — do NOT guess paths. GET /endpoints returns machine-readable list of all valid endpoints. Visão geral da API e URL base A API do Synapse é uma API HTTP RESTful. Todos os endpoints retornam JSON (exceto quando indicado de outra forma). Esta página cobre o essencial que você precisa antes de explorar endpoints específicos. URL base [CODE BLOCK] Todos os caminhos nesta documentação são relativos a esta URL base. Para instâncias auto-hospedadas, substitua pela sua própria URL. Autenticação Dois métodos, ambos enviados via cabeçalho : [CODE BLOCK] Ou via parâmetro de consulta (limitado a 60/min): [CODE BLOCK] Consulte Autenticação para detalhes. Grupos de endpoints | Grupo | Auth | Descrição | |-------|------|-----------| | Público | Nenhuma | Página inicial, health, OpenAPI, docs | | Memória | Mind Key | CRUD, busca, sincronização, embeddings | | Chat | Mind Key / JWT | Mensagens assíncronas entre humano e agente | | Tarefas | Mind Key | Gerenciamento de tarefas | | Scripts | Mind Key / JWT | Armazenamento persistente de scripts | | Agendador | Mind Key | Cron jobs + variáveis | | Webhooks | Mind Key | Callbacks HTTP em eventos | | Computadores | Mind Key / JWT | Controle de computadores remotos | | Usuário/Minds | JWT | Conta + gerenciamento de minds | | Compartilhamento | JWT | Compartilhamento de minds entre usuários | | Push | JWT | Assinaturas Web Push | | Ferramentas | Nenhuma | Hora, calc, aleatório (utilidades públicas) | Formatos de resposta - JSON (padrão): - Texto puro: retorna texto otimizado para LLMs - HTML: , , , , Envelope de resposta padrão Respostas de sucesso retornam os dados diretamente: [CODE BLOCK] Respostas de erro usam este formato: [CODE BLOCK] > [!NOTE] > O campo aponta para a documentação relevante dos erros comuns. Códigos de status HTTP | Código | Significado | |--------|-------------| | 200 | Sucesso (GET, PUT) | | 201 | Criado (POST) | | 204 | Sem conteúdo (DELETE) | | 400 | Requisição inválida (erro de validação) | | 401 | Não autorizado (token ausente/inválido) | | 403 | Proibido (tipo de token incorreto) | | 404 | Não encontrado (caminho não existe) | | 409 | Conflito (duplicado) | | 429 | Muitas requisições (rate limit) | | 500 | Erro de servidor | Endpoints de descoberta | Endpoint | Finalidade | |----------|------------| | | Página inicial (otimizada para LLMs) | | | Lista legível por máquina de todos os endpoints | | | Lista de endpoints em texto puro | | | Especificação OpenAPI 3.0 | | | Documentação completa da API (HTML) | | | Docs da API em JSON | | | Sistema de documentação (HTML) | | | Índice da documentação (JSON) | | | Todas as docs em um único bloco de texto | | | Playground interativo da API | Limites de taxa (rate limits) | Método de auth | Limite | |----------------|--------| | Mind Key (header) | Nenhum | | Mind Key (?key=) | 60/min por IP | | JWT (header) | Nenhum | | Endpoints públicos | Nenhum | Respostas com limite de taxa incluem: [CODE BLOCK] Paginação Endpoints de listagem suportam e : [CODE BLOCK] Limite padrão: 100. Limite máximo: 500. CORS Todos os endpoints suportam CORS para clientes baseados em navegador: [CODE BLOCK] SDKs e clientes - SDK Node.js: (repo) - Servidor MCP: (repo) - Cliente HTTP: qualquer biblioteca HTTP (curl, fetch, axios, etc.) Próximos passos - API de Memória — os endpoints mais importantes - API de Chat — comunicação assíncrona humano-agente - Erros e tratamento de erros