{"title":"API-overzicht & Base URL","slug":"overview","category":"api","summary":"Alle Synapse API-eindpunten, base URL, auth-patronen en responsformaten in één oogopslag.","audience":["human","llm"],"tags":["api","overview","endpoints"],"difficulty":"beginner","updated":"2026-06-27","word_count":506,"read_minutes":3,"llm_context":"Base URL: https://synapse.schaefer.zone\nAuth: Authorization: Bearer YOUR_MIND_KEY (header, no rate limit)\n OR ?key=YOUR_MIND_KEY (query, 60 req/min)\nAll responses are JSON except /memory/recall (text/plain) and /docs (HTML/text/json)\nAll 404 responses mean the path does not exist — do NOT guess paths.\nGET /endpoints returns machine-readable list of all valid endpoints.\n","lang":"nl","translated":true,"requested_lang":"nl","content_markdown":"\n# API-overzicht & Base URL\n\nDe Synapse API is een RESTful HTTP-API. Alle eindpunten retourneren JSON (behalve waar\nvermeld). Deze pagina behandelt de essentiële zaken voordat u naar specifieke\neindpunten duikt.\n\n## Base URL\n\n```\nhttps://synapse.schaefer.zone\n```\n\nAlle paden in deze documentatie zijn relatief ten opzichte van deze base URL. Voor\nself-hosted instanties vervangt u dit door uw eigen URL.\n\n## Authenticatie\n\nTwee methoden, beide via de `Authorization`-header:\n\n```\nAuthorization: Bearer YOUR_MIND_KEY # voor data-eindpunten\nAuthorization: Bearer YOUR_JWT # voor account-eindpunten\n```\n\nOf via queryparameter (ratelimited tot 60/min):\n\n```\n?key=YOUR_MIND_KEY\n```\n\nZie [Authenticatie](/docs/getting-started/authentication) voor details.\n\n## Eindpuntgroepen\n\n| Groep | Auth | Beschrijving |\n|-------|------|--------------|\n| Public | Geen | Landingspagina, health, OpenAPI, docs |\n| Memory | Mind Key | CRUD, zoeken, synchroniseren, embeddings |\n| Chat | Mind Key / JWT | Asynchrone berichtenuitwisseling tussen mens en agent |\n| Tasks | Mind Key | Taakbeheer |\n| Scripts | Mind Key / JWT | Permanente script-opslag |\n| Scheduler | Mind Key | Cron-jobs + variabelen |\n| Webhooks | Mind Key | HTTP-callbacks bij gebeurtenissen |\n| Computers | Mind Key / JWT | Bediening van computers op afstand |\n| User/Minds | JWT | Account + mind-beheer |\n| Sharing | JWT | Mind delen tussen gebruikers |\n| Push | JWT | Web Push-abonnementen |\n| Tools | Geen | Tijd, calc, random (openbare hulpmiddelen) |\n\n## Responsformaten\n\n- **JSON** (standaard): `{ \"key\": \"value\", ... }`\n- **Platte tekst**: `/memory/recall` retourneert op LLM geoptimaliseerde tekst\n- **HTML**: `/`, `/docs`, `/human`, `/support`, `/playground`\n\n## Standaard respons-envelope\n\nSuccesresponsen retourneren de data direct:\n\n```json\n{ \"id\": \"mem_001\", \"status\": \"stored\" }\n```\n\nFoutresponsen gebruiken dit formaat:\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> [!NOTE]\n> Het `docs`-veld verwijst naar relevante documentatie voor veelvoorkomende fouten.\n\n## HTTP-statuscodes\n\n| Code | Betekenis |\n|------|-----------|\n| 200 | Succes (GET, PUT) |\n| 201 | Aangemaakt (POST) |\n| 204 | Geen inhoud (DELETE) |\n| 400 | Onjuist verzoek (validatiefout) |\n| 401 | Niet-geautoriseerd (ontbrekend/ongeldig token) |\n| 403 | Verboden (verkeerd tokentype) |\n| 404 | Niet gevonden (pad bestaat niet) |\n| 409 | Conflict (dubbeling) |\n| 429 | Te veel verzoeken (ratelimit) |\n| 500 | Serverfout |\n\n## Ontdekkings-eindpunten\n\n| Eindpunt | Doel |\n|----------|------|\n| `GET /` | Landingspagina (op LLM geoptimaliseerd) |\n| `GET /endpoints` | Machineleesbare lijst van alle eindpunten |\n| `GET /endpoints?format=text` | Plattetekst eindpuntlijst |\n| `GET /openapi.json` | OpenAPI 3.0-specificatie |\n| `GET /help` | Volledige API-documentatie (HTML) |\n| `GET /help?format=json` | API-documentatie als JSON |\n| `GET /docs` | Documentatiesysteem (HTML) |\n| `GET /docs?format=json` | Documentatie-index (JSON) |\n| `GET /docs?format=text&scope=all` | Alle documentatie als één tekstblok |\n| `GET /playground` | Interactieve API-playground |\n\n## Ratelimits\n\n| Auth-methode | Limiet |\n|--------------|--------|\n| Mind Key (header) | Geen |\n| Mind Key (?key=) | 60/min per IP |\n| JWT (header) | Geen |\n| Openbare eindpunten | Geen |\n\nRatelimited responsen bevatten:\n\n```\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 42\nRetry-After: 30 (only when 429)\n```\n\n## Paginering\n\nLijst-eindpunten ondersteunen `?limit=` en `?offset=`:\n\n```\nGET /memory?limit=50&offset=100\nGET /mind/tasks?status=pending\n```\n\nStandaardlimiet: 100. Maximale limiet: 500.\n\n## CORS\n\nAlle eindpunten ondersteunen CORS voor browser-gebaseerde clients:\n\n```\nAccess-Control-Allow-Origin: *\nAccess-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS\nAccess-Control-Allow-Headers: Authorization, Content-Type, X-Synapse-JWT, Mcp-Session-Id, Mcp-Tool-Profile\n```\n\n## SDK's & Clients\n\n- **Node.js SDK**: `npm install synapse-memory-sdk` ([repo](https://gitlab.com/schaefer-services/synapse-sdk-js))\n- **MCP Server**: `npx -y synapse-mcp-api@latest` ([repo](https://gitlab.com/schaefer-services/synapse-mcp))\n- **HTTP-client**: elke HTTP-bibliotheek (curl, fetch, axios, enz.)\n\n## Volgende stappen\n\n- [Memory API](/docs/api/memory) — de belangrijkste eindpunten\n- [Chat API](/docs/api/chat) — asynchrone communicatie tussen mens en agent\n- [Fouten & Foutafhandeling](/docs/api/errors)\n","content_html":"

API-overzicht & Base URL

\n

De Synapse API is een RESTful HTTP-API. Alle eindpunten retourneren JSON (behalve waar\nvermeld). Deze pagina behandelt de essentiële zaken voordat u naar specifieke\neindpunten duikt.

\n

Base URL

\n
https://synapse.schaefer.zone

Alle paden in deze documentatie zijn relatief ten opzichte van deze base URL. Voor\nself-hosted instanties vervangt u dit door uw eigen URL.

\n

Authenticatie

\n

Twee methoden, beide via de Authorization-header:

\n
Authorization: Bearer YOUR_MIND_KEY    # voor data-eindpunten\nAuthorization: Bearer YOUR_JWT          # voor account-eindpunten

Of via queryparameter (ratelimited tot 60/min):

\n
?key=YOUR_MIND_KEY

Zie Authenticatie voor details.

\n

Eindpuntgroepen

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
GroepAuthBeschrijving
PublicGeenLandingspagina, health, OpenAPI, docs
MemoryMind KeyCRUD, zoeken, synchroniseren, embeddings
ChatMind Key / JWTAsynchrone berichtenuitwisseling tussen mens en agent
TasksMind KeyTaakbeheer
ScriptsMind Key / JWTPermanente script-opslag
SchedulerMind KeyCron-jobs + variabelen
WebhooksMind KeyHTTP-callbacks bij gebeurtenissen
ComputersMind Key / JWTBediening van computers op afstand
User/MindsJWTAccount + mind-beheer
SharingJWTMind delen tussen gebruikers
PushJWTWeb Push-abonnementen
ToolsGeenTijd, calc, random (openbare hulpmiddelen)
\n

Responsformaten

\n\n

Standaard respons-envelope

\n

Succesresponsen retourneren de data direct:

\n
{ "id": "mem_001", "status": "stored" }

Foutresponsen gebruiken dit formaat:

\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}
Het `docs`-veld verwijst naar relevante documentatie voor veelvoorkomende fouten.

HTTP-statuscodes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeBetekenis
200Succes (GET, PUT)
201Aangemaakt (POST)
204Geen inhoud (DELETE)
400Onjuist verzoek (validatiefout)
401Niet-geautoriseerd (ontbrekend/ongeldig token)
403Verboden (verkeerd tokentype)
404Niet gevonden (pad bestaat niet)
409Conflict (dubbeling)
429Te veel verzoeken (ratelimit)
500Serverfout
\n

Ontdekkings-eindpunten

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EindpuntDoel
GET /Landingspagina (op LLM geoptimaliseerd)
GET /endpointsMachineleesbare lijst van alle eindpunten
GET /endpoints?format=textPlattetekst eindpuntlijst
GET /openapi.jsonOpenAPI 3.0-specificatie
GET /helpVolledige API-documentatie (HTML)
GET /help?format=jsonAPI-documentatie als JSON
GET /docsDocumentatiesysteem (HTML)
GET /docs?format=jsonDocumentatie-index (JSON)
GET /docs?format=text&scope=allAlle documentatie als één tekstblok
GET /playgroundInteractieve API-playground
\n

Ratelimits

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Auth-methodeLimiet
Mind Key (header)Geen
Mind Key (?key=)60/min per IP
JWT (header)Geen
Openbare eindpuntenGeen
\n

Ratelimited responsen bevatten:

\n
X-RateLimit-Limit: 60\nX-RateLimit-Remaining: 42\nRetry-After: 30  (only when 429)

Paginering

\n

Lijst-eindpunten ondersteunen ?limit= en ?offset=:

\n
GET /memory?limit=50&offset=100\nGET /mind/tasks?status=pending

Standaardlimiet: 100. Maximale limiet: 500.

\n

CORS

\n

Alle eindpunten ondersteunen CORS voor browser-gebaseerde clients:

\n
Access-Control-Allow-Origin: *\nAccess-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS\nAccess-Control-Allow-Headers: Authorization, Content-Type, X-Synapse-JWT, Mcp-Session-Id, Mcp-Tool-Profile

SDK's & Clients

\n\n

Volgende stappen

\n\n","urls":{"html":"/docs/api/overview","text":"/docs/api/overview?format=text","json":"/docs/api/overview?format=json","llm":"/docs/api/overview?format=llm"},"translations_available":["en","zh","hi","es","fr","ar","pt","ru","ja","de","it","ko","nl","pl","tr","sv","vi","th","id","uk"]}