{"title":"API-översikt & bas-URL","slug":"overview","category":"api","summary":"Alla Synapse API-endpoints, bas-URL, autentiseringsmönster och svarsformat i korthet.","audience":["human","llm"],"tags":["api","overview","endpoints"],"difficulty":"beginner","updated":"2026-06-27","word_count":494,"read_minutes":2,"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":"sv","translated":true,"requested_lang":"sv","content_markdown":"\n# API-översikt & bas-URL\n\nSynapse API är ett RESTful HTTP-API. Alla endpoints returnerar JSON (utom där\nangivet). Den här sidan täcker det ni behöver veta innan ni dyker in i specifika\nendpoints.\n\n## Bas-URL\n\n```\nhttps://synapse.schaefer.zone\n```\n\nAlla sökvägar i denna dokumentation är relativa till denna bas-URL. För\nsjälvvärdda instanser, ersätt med er egen URL.\n\n## Autentisering\n\nTvå metoder, båda skickade via `Authorization`-header:\n\n```\nAuthorization: Bearer YOUR_MIND_KEY # for data endpoints\nAuthorization: Bearer YOUR_JWT # for account endpoints\n```\n\nEller via queryparameter (hastighetsbegränsad till 60/min):\n\n```\n?key=YOUR_MIND_KEY\n```\n\nSe [Autentisering](/docs/getting-started/authentication) för detaljer.\n\n## Endpoint-grupper\n\n| Grupp | Autentisering | Beskrivning |\n|-------|------|-------------|\n| Publik | Ingen | Landningssida, hälsa, OpenAPI, dokumentation |\n| Memory | Mind Key | CRUD, sökning, synk, inbäddningar |\n| Chat | Mind Key / JWT | Asynkrona meddelanden mellan människa och agent |\n| Tasks | Mind Key | Uppgiftshantering |\n| Scripts | Mind Key / JWT | Beständig skriptlagring |\n| Scheduler | Mind Key | Cron-jobb + variabler |\n| Webhooks | Mind Key | HTTP-återanrop vid händelser |\n| Computers | Mind Key / JWT | Fjärrstyrning av datorer |\n| User/Minds | JWT | Konto + mind-hantering |\n| Sharing | JWT | Mind-delning mellan användare |\n| Push | JWT | Web Push-prenumerationer |\n| Tools | Ingen | Tid, kalkyl, slump (publika verktyg) |\n\n## Svarsformat\n\n- **JSON** (standard): `{ \"key\": \"value\", ... }`\n- **Oformaterad text**: `/memory/recall` returnerar LLM-optimerad text\n- **HTML**: `/`, `/docs`, `/human`, `/support`, `/playground`\n\n## Standard kuvert för svar\n\nLyckade svar returnerar datan direkt:\n\n```json\n{ \"id\": \"mem_001\", \"status\": \"stored\" }\n```\n\nFelsvar använder detta format:\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> Fältet `docs` länkar till relevant dokumentation för vanliga fel.\n\n## HTTP-statuskoder\n\n| Kod | Betydelse |\n|------|---------|\n| 200 | Lyckades (GET, PUT) |\n| 201 | Skapad (POST) |\n| 204 | Inget innehåll (DELETE) |\n| 400 | Felaktig begäran (valideringsfel) |\n| 401 | Obehörig (saknas/ogiltig token) |\n| 403 | Förbjuden (fel tokentyp) |\n| 404 | Hittades inte (sökvägen finns inte) |\n| 409 | Konflikt (dubblett) |\n| 429 | För många begäranden (hastighetsgräns) |\n| 500 | Serverfel |\n\n## Upptäckbarhets-endpoints\n\n| Endpoint | Syfte |\n|----------|---------|\n| `GET /` | Landningssida (LLM-optimerad) |\n| `GET /endpoints` | Maskinläsbar lista över alla endpoints |\n| `GET /endpoints?format=text` | Ofärmaterad endpoint-lista |\n| `GET /openapi.json` | OpenAPI 3.0-specifikation |\n| `GET /help` | Fullständig API-dokumentation (HTML) |\n| `GET /help?format=json` | API-dokumentation som JSON |\n| `GET /docs` | Dokumentationssystem (HTML) |\n| `GET /docs?format=json` | Dokumentationsindex (JSON) |\n| `GET /docs?format=text&scope=all` | All dokumentation som ett textblock |\n| `GET /playground` | Interaktiv API-playground |\n\n## Hastighetsgränser\n\n| Autentiseringsmetod | Gräns |\n|-------------|-------|\n| Mind Key (header) | Ingen |\n| Mind Key (?key=) | 60/min per IP |\n| JWT (header) | Ingen |\n| Publika endpoints | Ingen |\n\nHastighetsbegränsade svar inkluderar:\n\n```\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 42\nRetry-After: 30 (only when 429)\n```\n\n## Paginering\n\nList-endpoints stöder `?limit=` och `?offset=`:\n\n```\nGET /memory?limit=50&offset=100\nGET /mind/tasks?status=pending\n```\n\nStandardgräns: 100. Maxgräns: 500.\n\n## CORS\n\nAlla endpoints stöder CORS för webbläsarbaserade klienter:\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:er & klienter\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-klient**: valfritt HTTP-bibliotek (curl, fetch, axios, etc.)\n\n## Nästa steg\n\n- [Memory API](/docs/api/memory) — de viktigaste endpoints\n- [Chat API](/docs/api/chat) — asynkron kommunikation mellan människa och agent\n- [Fel & felhantering](/docs/api/errors)\n","content_html":"

API-översikt & bas-URL

\n

Synapse API är ett RESTful HTTP-API. Alla endpoints returnerar JSON (utom där\nangivet). Den här sidan täcker det ni behöver veta innan ni dyker in i specifika\nendpoints.

\n

Bas-URL

\n
https://synapse.schaefer.zone

Alla sökvägar i denna dokumentation är relativa till denna bas-URL. För\nsjälvvärdda instanser, ersätt med er egen URL.

\n

Autentisering

\n

Två metoder, båda skickade via Authorization-header:

\n
Authorization: Bearer YOUR_MIND_KEY    # for data endpoints\nAuthorization: Bearer YOUR_JWT          # for account endpoints

Eller via queryparameter (hastighetsbegränsad till 60/min):

\n
?key=YOUR_MIND_KEY

Se Autentisering för detaljer.

\n

Endpoint-grupper

\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
GruppAutentiseringBeskrivning
PublikIngenLandningssida, hälsa, OpenAPI, dokumentation
MemoryMind KeyCRUD, sökning, synk, inbäddningar
ChatMind Key / JWTAsynkrona meddelanden mellan människa och agent
TasksMind KeyUppgiftshantering
ScriptsMind Key / JWTBeständig skriptlagring
SchedulerMind KeyCron-jobb + variabler
WebhooksMind KeyHTTP-återanrop vid händelser
ComputersMind Key / JWTFjärrstyrning av datorer
User/MindsJWTKonto + mind-hantering
SharingJWTMind-delning mellan användare
PushJWTWeb Push-prenumerationer
ToolsIngenTid, kalkyl, slump (publika verktyg)
\n

Svarsformat

\n\n

Standard kuvert för svar

\n

Lyckade svar returnerar datan direkt:

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

Felsvar använder detta format:

\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}
Fältet `docs` länkar till relevant dokumentation för vanliga fel.

HTTP-statuskoder

\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
KodBetydelse
200Lyckades (GET, PUT)
201Skapad (POST)
204Inget innehåll (DELETE)
400Felaktig begäran (valideringsfel)
401Obehörig (saknas/ogiltig token)
403Förbjuden (fel tokentyp)
404Hittades inte (sökvägen finns inte)
409Konflikt (dubblett)
429För många begäranden (hastighetsgräns)
500Serverfel
\n

Upptäckbarhets-endpoints

\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
EndpointSyfte
GET /Landningssida (LLM-optimerad)
GET /endpointsMaskinläsbar lista över alla endpoints
GET /endpoints?format=textOfärmaterad endpoint-lista
GET /openapi.jsonOpenAPI 3.0-specifikation
GET /helpFullständig API-dokumentation (HTML)
GET /help?format=jsonAPI-dokumentation som JSON
GET /docsDokumentationssystem (HTML)
GET /docs?format=jsonDokumentationsindex (JSON)
GET /docs?format=text&scope=allAll dokumentation som ett textblock
GET /playgroundInteraktiv API-playground
\n

Hastighetsgränser

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AutentiseringsmetodGräns
Mind Key (header)Ingen
Mind Key (?key=)60/min per IP
JWT (header)Ingen
Publika endpointsIngen
\n

Hastighetsbegränsade svar inkluderar:

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

Paginering

\n

List-endpoints stöder ?limit= och ?offset=:

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

Standardgräns: 100. Maxgräns: 500.

\n

CORS

\n

Alla endpoints stöder CORS för webbläsarbaserade klienter:

\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:er & klienter

\n\n

Nästa steg

\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"]}