# API Overview & Base URL
SUMMARY: All Synapse API endpoints, base URL, auth patterns, and response formats at a glance.

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 Overview & Base URL
The Synapse API is a RESTful HTTP API. All endpoints return JSON (except where
noted). This page covers the essentials you need before diving into specific
endpoints.
Base URL
[CODE BLOCK]
All paths in this documentation are relative to this base URL. For self-hosted
instances, replace with your own URL.
Authentication
Two methods, both sent via  header:
[CODE BLOCK]
Or via query parameter (rate-limited to 60/min):
[CODE BLOCK]
See Authentication for details.
Endpoint Groups
| Group | Auth | Description |
|-------|------|-------------|
| Public | None | Landing page, health, OpenAPI, docs |
| Memory | Mind Key | CRUD, search, sync, embeddings |
| Chat | Mind Key / JWT | Async messaging between human and agent |
| Tasks | Mind Key | Task management |
| Scripts | Mind Key / JWT | Persistent script store |
| Scheduler | Mind Key | Cron jobs + variables |
| Webhooks | Mind Key | HTTP callbacks on events |
| Computers | Mind Key / JWT | Remote computer control |
| User/Minds | JWT | Account + mind management |
| Sharing | JWT | Mind sharing between users |
| Push | JWT | Web Push subscriptions |
| Tools | None | Time, calc, random (public utilities) |
Response Formats
- JSON (default): 
- Plain text:  returns LLM-optimized text
- HTML: , , , , 
Standard Response Envelope
Success responses return the data directly:
[CODE BLOCK]
Error responses use this format:
[CODE BLOCK]
> [!NOTE]
> The  field links to relevant documentation for common errors.
HTTP Status Codes
| Code | Meaning |
|------|---------|
| 200 | Success (GET, PUT) |
| 201 | Created (POST) |
| 204 | No content (DELETE) |
| 400 | Bad request (validation error) |
| 401 | Unauthorized (missing/invalid token) |
| 403 | Forbidden (wrong token type) |
| 404 | Not found (path doesn't exist) |
| 409 | Conflict (duplicate) |
| 429 | Too many requests (rate limit) |
| 500 | Server error |
Discoverability Endpoints
| Endpoint | Purpose |
|----------|---------|
|  | Landing page (LLM-optimized) |
|  | Machine-readable list of all endpoints |
|  | Plain-text endpoint list |
|  | OpenAPI 3.0 specification |
|  | Full API documentation (HTML) |
|  | API docs as JSON |
|  | Documentation system (HTML) |
|  | Documentation index (JSON) |
|  | All docs as one text block |
|  | Interactive API playground |
Rate Limits
| Auth Method | Limit |
|-------------|-------|
| Mind Key (header) | None |
| Mind Key (?key=) | 60/min per IP |
| JWT (header) | None |
| Public endpoints | None |
Rate-limited responses include:
[CODE BLOCK]
Pagination
List endpoints support  and :
[CODE BLOCK]
Default limit: 100. Max limit: 500.
CORS
All endpoints support CORS for browser-based clients:
[CODE BLOCK]
SDKs & Clients
- Node.js SDK:  (repo)
- MCP Server:  (repo)
- HTTP client: any HTTP library (curl, fetch, axios, etc.)
Next Steps
- Memory API — the most important endpoints
- Chat API — async human-agent communication
- Errors & Error Handling