API Reference¶
Kaisho exposes a REST API on http://localhost:8765/api/. All endpoints return JSON unless noted otherwise.
Base URL¶
Authentication¶
The local API has no authentication. It is designed for single-user access on localhost. CORS is restricted to local development origins.
Common Patterns¶
List endpoints return arrays:
Create endpoints return the created object with HTTP 201.
Update endpoints accept partial objects (only changed fields) and return the updated object.
Delete endpoints return HTTP 204 with no body.
Error responses use standard HTTP status codes:
| Code | Meaning |
|---|---|
| 400 | Validation error (bad input) |
| 404 | Resource not found |
| 409 | Conflict (e.g., duplicate name) |
| 502 | Cloud service unavailable |
Error bodies:
Health Check¶
Returns {"status": "ok"}. Use this to verify the server is running.
WebSocket¶
Real-time updates are pushed via WebSocket at ws://localhost:8765/ws. See WebSocket.
Endpoints by Domain¶
| Section | Prefix | Description |
|---|---|---|
| Clocks | /api/clocks | Time tracking |
| Tasks | /api/kanban | Task management |
| Customers | /api/customers | Customer and contract CRUD |
| Inbox | /api/inbox | Inbox item capture and triage |
| Notes | /api/notes | Note management |
| Knowledge | /api/knowledge | Knowledge base files |
| Dashboard | /api/dashboard | Summary metrics |
| Advisor | /api/advisor | AI assistant |
| Cron | /api/cron | Scheduled jobs |
| GitHub | /api/github | GitHub integration |
| Cloud Sync | /api/cloud-sync | Cloud synchronization |
| Settings | /api/settings | Configuration |
| WebSocket | /ws | Real-time events |