Skip to content

API Overview ​

SkimpyClaw exposes two groups of HTTP endpoints on port 18790:

GroupPrefixAuthPurpose
Gateway/NoneHealth, status, message relay, cron triggers
Dashboard/api/dashboard/*Bearer tokenFull 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:

MethodPathDescription
GET/healthReturns { status: 'ok', uptime }
GET/statusFull status: model, agent, cron jobs, last message
POST/messageSend message to agent. Body: { message, model? }
POST/modelSwitch model. Body: { model }
POST/cron/:id/runTrigger a cron job by ID
POST/reloadPlaceholder (requires full restart)

Dashboard API Categories ​

The dashboard API has 40+ endpoints organized by domain:

Quick Examples ​

Check health ​

bash
curl http://localhost:18790/health

Send 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'