{"title":"Ikhtisar API & Base URL","slug":"overview","category":"api","summary":"Semua endpoint API Synapse, base URL, pola autentikasi, dan format respons dalam sekali pandang.","audience":["human","llm"],"tags":["api","overview","endpoints"],"difficulty":"beginner","updated":"2026-06-27","word_count":548,"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":"id","translated":true,"requested_lang":"id","content_markdown":"\n# Ikhtisar API & Base URL\n\nSynapse API adalah HTTP API yang RESTful. Semua endpoint mengembalikan JSON\n(kecuali jika dicatat). Halaman ini mencakup hal-hal penting yang perlu Anda\nketahui sebelum mendalami endpoint tertentu.\n\n## Base URL\n\n```\nhttps://synapse.schaefer.zone\n```\n\nSemua path dalam dokumentasi ini relatif terhadap base URL ini. Untuk instansi\nself-hosted, ganti dengan URL Anda sendiri.\n\n## Autentikasi\n\nDua metode, keduanya dikirim melalui header `Authorization`:\n\n```\nAuthorization: Bearer YOUR_MIND_KEY # untuk endpoint data\nAuthorization: Bearer YOUR_JWT # untuk endpoint akun\n```\n\nAtau melalui parameter query (rate-limited ke 60/menit):\n\n```\n?key=YOUR_MIND_KEY\n```\n\nLihat [Autentikasi](/docs/getting-started/authentication) untuk detailnya.\n\n## Grup Endpoint\n\n| Grup | Auth | Deskripsi |\n|-------|------|-------------|\n| Public | Tidak ada | Landing page, health, OpenAPI, docs |\n| Memory | Mind Key | CRUD, pencarian, sinkronisasi, embeddings |\n| Chat | Mind Key / JWT | Pesan asinkron antara manusia dan agen |\n| Tasks | Mind Key | Manajemen tugas |\n| Scripts | Mind Key / JWT | Penyimpanan skrip persisten |\n| Scheduler | Mind Key | Cron jobs + variabel |\n| Webhooks | Mind Key | HTTP callback pada event |\n| Computers | Mind Key / JWT | Kontrol komputer remote |\n| User/Minds | JWT | Akun + manajemen mind |\n| Sharing | JWT | Berbagi mind antar pengguna |\n| Push | JWT | Langganan Web Push |\n| Tools | Tidak ada | Waktu, kalkulator, acak (utilitas publik) |\n\n## Format Respons\n\n- **JSON** (default): `{ \"key\": \"value\", ... }`\n- **Teks polos**: `/memory/recall` mengembalikan teks yang dioptimalkan untuk LLM\n- **HTML**: `/`, `/docs`, `/human`, `/support`, `/playground`\n\n## Amplop Respons Standar\n\nRespons sukses mengembalikan data secara langsung:\n\n```json\n{ \"id\": \"mem_001\", \"status\": \"stored\" }\n```\n\nRespons error menggunakan format ini:\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> Field `docs` menautkan ke dokumentasi terkait untuk error umum.\n\n## Kode Status HTTP\n\n| Kode | Arti |\n|------|---------|\n| 200 | Sukses (GET, PUT) |\n| 201 | Created (POST) |\n| 204 | No content (DELETE) |\n| 400 | Bad request (error validasi) |\n| 401 | Unauthorized (token tidak ada/tidak valid) |\n| 403 | Forbidden (tipe token salah) |\n| 404 | Not found (path tidak ada) |\n| 409 | Conflict (duplikat) |\n| 429 | Too many requests (rate limit) |\n| 500 | Server error |\n\n## Endpoint Discoverability\n\n| Endpoint | Tujuan |\n|----------|---------|\n| `GET /` | Landing page (dioptimalkan untuk LLM) |\n| `GET /endpoints` | Daftar yang dapat dibaca mesin dari semua endpoint |\n| `GET /endpoints?format=text` | Daftar endpoint teks polos |\n| `GET /openapi.json` | Spesifikasi OpenAPI 3.0 |\n| `GET /help` | Dokumentasi API lengkap (HTML) |\n| `GET /help?format=json` | Dokumentasi API sebagai JSON |\n| `GET /docs` | Sistem dokumentasi (HTML) |\n| `GET /docs?format=json` | Indeks dokumentasi (JSON) |\n| `GET /docs?format=text&scope=all` | Semua dokumentasi sebagai satu blok teks |\n| `GET /playground` | Playground API interaktif |\n\n## Rate Limits\n\n| Metode Auth | Batas |\n|-------------|-------|\n| Mind Key (header) | Tidak ada |\n| Mind Key (?key=) | 60/menit per IP |\n| JWT (header) | Tidak ada |\n| Endpoint publik | Tidak ada |\n\nRespons yang di-rate-limit menyertakan:\n\n```\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 42\nRetry-After: 30 (hanya saat 429)\n```\n\n## Paginasi\n\nEndpoint daftar mendukung `?limit=` dan `?offset=`:\n\n```\nGET /memory?limit=50&offset=100\nGET /mind/tasks?status=pending\n```\n\nLimit default: 100. Limit maksimum: 500.\n\n## CORS\n\nSemua endpoint mendukung CORS untuk klien berbasis browser:\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 & Klien\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**: pustaka HTTP apa pun (curl, fetch, axios, dll.)\n\n## Langkah Berikutnya\n\n- [Memory API](/docs/api/memory) — endpoint terpenting\n- [Chat API](/docs/api/chat) — komunikasi asinkron manusia-agen\n- [Errors & Error Handling](/docs/api/errors)\n","content_html":"

Ikhtisar API & Base URL

\n

Synapse API adalah HTTP API yang RESTful. Semua endpoint mengembalikan JSON\n(kecuali jika dicatat). Halaman ini mencakup hal-hal penting yang perlu Anda\nketahui sebelum mendalami endpoint tertentu.

\n

Base URL

\n
https://synapse.schaefer.zone

Semua path dalam dokumentasi ini relatif terhadap base URL ini. Untuk instansi\nself-hosted, ganti dengan URL Anda sendiri.

\n

Autentikasi

\n

Dua metode, keduanya dikirim melalui header Authorization:

\n
Authorization: Bearer YOUR_MIND_KEY    # untuk endpoint data\nAuthorization: Bearer YOUR_JWT          # untuk endpoint akun

Atau melalui parameter query (rate-limited ke 60/menit):

\n
?key=YOUR_MIND_KEY

Lihat Autentikasi untuk detailnya.

\n

Grup Endpoint

\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
GrupAuthDeskripsi
PublicTidak adaLanding page, health, OpenAPI, docs
MemoryMind KeyCRUD, pencarian, sinkronisasi, embeddings
ChatMind Key / JWTPesan asinkron antara manusia dan agen
TasksMind KeyManajemen tugas
ScriptsMind Key / JWTPenyimpanan skrip persisten
SchedulerMind KeyCron jobs + variabel
WebhooksMind KeyHTTP callback pada event
ComputersMind Key / JWTKontrol komputer remote
User/MindsJWTAkun + manajemen mind
SharingJWTBerbagi mind antar pengguna
PushJWTLangganan Web Push
ToolsTidak adaWaktu, kalkulator, acak (utilitas publik)
\n

Format Respons

\n\n

Amplop Respons Standar

\n

Respons sukses mengembalikan data secara langsung:

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

Respons error menggunakan format ini:

\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}
Field `docs` menautkan ke dokumentasi terkait untuk error umum.

Kode Status HTTP

\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
KodeArti
200Sukses (GET, PUT)
201Created (POST)
204No content (DELETE)
400Bad request (error validasi)
401Unauthorized (token tidak ada/tidak valid)
403Forbidden (tipe token salah)
404Not found (path tidak ada)
409Conflict (duplikat)
429Too many requests (rate limit)
500Server error
\n

Endpoint Discoverability

\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
EndpointTujuan
GET /Landing page (dioptimalkan untuk LLM)
GET /endpointsDaftar yang dapat dibaca mesin dari semua endpoint
GET /endpoints?format=textDaftar endpoint teks polos
GET /openapi.jsonSpesifikasi OpenAPI 3.0
GET /helpDokumentasi API lengkap (HTML)
GET /help?format=jsonDokumentasi API sebagai JSON
GET /docsSistem dokumentasi (HTML)
GET /docs?format=jsonIndeks dokumentasi (JSON)
GET /docs?format=text&scope=allSemua dokumentasi sebagai satu blok teks
GET /playgroundPlayground API interaktif
\n

Rate Limits

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Metode AuthBatas
Mind Key (header)Tidak ada
Mind Key (?key=)60/menit per IP
JWT (header)Tidak ada
Endpoint publikTidak ada
\n

Respons yang di-rate-limit menyertakan:

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

Paginasi

\n

Endpoint daftar mendukung ?limit= dan ?offset=:

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

Limit default: 100. Limit maksimum: 500.

\n

CORS

\n

Semua endpoint mendukung CORS untuk klien berbasis browser:

\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 & Klien

\n\n

Langkah Berikutnya

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