# API-Übersicht & Basis-URL SUMMARY: Alle Synapse-API-Endpunkte, Basis-URL, Authentifizierungsmuster und Antwortformate auf einen Blick. 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. API-Übersicht & Basis-URL Die Synapse-API ist eine RESTful-HTTP-API. Alle Endpunkte liefern JSON zurück (ausgenommen sind explizit gekennzeichnete Fälle). Diese Seite behandelt die Grundlagen, die du kennen solltest, bevor du dich den spezifischen Endpunkten widmest. Basis-URL [CODE BLOCK] Alle Pfade in dieser Dokumentation sind relativ zu dieser Basis-URL. Für selbstgehostete Instanzen ersetze sie durch deine eigene URL. Authentifizierung Zwei Methoden, beide über den -Header: [CODE BLOCK] Oder über einen Query-Parameter (auf 60/min begrenzt): [CODE BLOCK] Siehe Authentifizierung für Details. Endpunkt-Gruppen | Gruppe | Auth | Beschreibung | |-------|------|--------------| | Öffentlich | Keine | Landing-Page, Health, OpenAPI, Docs | | Memory | Mind Key | CRUD, Suche, Sync, Embeddings | | Chat | Mind Key / JWT | Asynchrone Nachrichten zwischen Mensch und Agent | | Tasks | Mind Key | Aufgabenverwaltung | | Scripts | Mind Key / JWT | Persistenter Script-Speicher | | Scheduler | Mind Key | Cron-Jobs + Variablen | | Webhooks | Mind Key | HTTP-Callbacks bei Events | | Computers | Mind Key / JWT | Fernsteuerung von Rechnern | | User/Minds | JWT | Konto- + Mind-Verwaltung | | Sharing | JWT | Mind-Freigaben zwischen Nutzern | | Push | JWT | Web-Push-Abonnements | | Tools | Keine | Zeit, Calc, Random (öffentliche Hilfswerkzeuge) | Antwortformate - JSON (Standard): - Klartext: liefert LLM-optimierten Text - HTML: , , , , Standard-Antwort-Envelope Erfolgsantworten liefern die Daten direkt: [CODE BLOCK] Fehlerantworten verwenden dieses Format: [CODE BLOCK] > [!NOTE] > Das Feld verlinkt bei häufigen Fehlern auf die relevante Doku. HTTP-Statuscodes | Code | Bedeutung | |------|-----------| | 200 | Erfolg (GET, PUT) | | 201 | Erstellt (POST) | | 204 | Kein Inhalt (DELETE) | | 400 | Bad Request (Validierungsfehler) | | 401 | Unauthorized (fehlender/ungültiger Token) | | 403 | Forbidden (falscher Token-Typ) | | 404 | Not Found (Pfad existiert nicht) | | 409 | Conflict (Duplikat) | | 429 | Too Many Requests (Rate Limit) | | 500 | Serverfehler | Discoverability-Endpunkte | Endpunkt | Zweck | |----------|-------| | | Landing-Page (LLM-optimiert) | | | Maschinenlesbare Liste aller Endpunkte | | | Endpunkt-Liste als Klartext | | | OpenAPI-3.0-Spezifikation | | | Vollständige API-Doku (HTML) | | | API-Doku als JSON | | | Dokumentationssystem (HTML) | | | Doku-Index (JSON) | | | Alle Docs als ein Textblock | | | Interaktives API-Playground | Rate Limits | Auth-Methode | Limit | |---------------|-------| | Mind Key (Header) | Keins | | Mind Key (?key=) | 60/min pro IP | | JWT (Header) | Keins | | Öffentliche Endpunkte | Keins | Rate-limitierte Antworten enthalten: [CODE BLOCK] Paginierung Listen-Endpunkte unterstützen und : [CODE BLOCK] Standard-Limit: 100. Max. Limit: 500. CORS Alle Endpunkte unterstützen CORS für browserbasierte Clients: [CODE BLOCK] SDKs & Clients - Node.js SDK: (Repo) - MCP Server: (Repo) - HTTP-Client: jede HTTP-Bibliothek (curl, fetch, axios, etc.) Nächste Schritte - Memory-API — die wichtigsten Endpunkte - Chat-API — asynchrone Mensch-Agent-Kommunikation - Errors & Fehlerbehandlung