API Overview ​
SkimpyClaw exposes two groups of HTTP endpoints on port 18790:
| Group | Prefix | Auth | Purpose |
|---|---|---|---|
| Gateway | / | None | Health, status, message relay, cron triggers |
| Dashboard | /api/dashboard/* | Bearer token | Full management API |
Authentication ​
All /api/dashboard/* routes require a Bearer token in the Authorization header:
Authorization: Bearer <token>The token is set in ~/.skimpyclaw/config.json under dashboard.token. If no token is configured, auth is skipped.
Gateway Routes ​
These are lightweight operational endpoints:
| Method | Path | Description |
|---|---|---|
GET | /health | Returns { status: 'ok', uptime } |
GET | /status | Full status: model, agent, cron jobs, last message |
POST | /message | Send message to agent. Body: { message, model? } |
POST | /model | Switch model. Body: { model } |
POST | /cron/:id/run | Trigger a cron job by ID |
POST | /reload | Placeholder (requires full restart) |
Dashboard API Categories ​
The dashboard API has 40+ endpoints organized by domain:
- REST API -- full endpoint reference
- Dashboard API -- interactive features (approvals, agents, digests)
Quick Examples ​
Check health ​
bash
curl http://localhost:18790/healthSend a message ​
bash
curl -X POST http://localhost:18790/message \
-H 'Content-Type: application/json' \
-d '{"message": "What time is it?"}'Get dashboard status ​
bash
curl http://localhost:18790/api/dashboard/status \
-H 'Authorization: Bearer YOUR_TOKEN'