Skip to content

REST API Reference ​

All endpoints are served by the Fastify gateway on port 18790. Dashboard endpoints require Bearer token auth.

Status & Configuration ​

MethodPathDescription
GET/api/dashboard/statusUptime, model, agent, active channel, cron jobs, subagent stats
GET/api/dashboard/configCurrent config (secrets redacted)
PUT/api/dashboard/configSave new config. Body: { config }
POST/api/dashboard/restartGraceful process restart
POST/api/dashboard/reloadHot-reload config, providers, cron, heartbeat, channels
GET/api/dashboard/healthHealth with feature toggles and env var status
GET/api/dashboard/doctorRun diagnostic checks

Model Management ​

MethodPathDescription
GET/api/dashboard/modelCurrent model, aliases, per-agent assignments
POST/api/dashboard/modelSet model. Body: { model } -- validated via resolveModelSelection

Sessions & Conversations ​

MethodPathParamsDescription
GET/api/dashboard/sessionsList all conversation sessions
GET/api/dashboard/sessions/:idGet full session (JSON)
GET/api/dashboard/conversationschannel?List telegram/discord conversations
GET/api/dashboard/conversations/:idlimit?, offset?Paginated messages (JSONL)

Messages ​

MethodPathDescription
POST/api/dashboard/messages/sendSend to active channel. Body: { message }
POST/api/dashboard/messages/agentRun through agent. Body: { message, model? }

Cron Jobs ​

MethodPathParamsDescription
GET/api/dashboard/cronList all cron jobs
GET/api/dashboard/cron/prompt-filepath (required)Read prompt file content
POST/api/dashboard/cron/:id/runTrigger job immediately

Memory & Templates ​

MethodPathDescription
GET/api/dashboard/memory/:agentIdList memory files
GET/api/dashboard/memory/:agentId/:filenameRead memory file (curated = MEMORY.md)
GET/api/dashboard/templates/:agentIdList template files with existence status
GET/api/dashboard/templates/:agentId/:nameRead template content
PUT/api/dashboard/templates/:agentId/:nameUpdate template. Body: { content }

Logs ​

MethodPathParamsDescription
GET/api/dashboard/logsList all log files recursively
GET/api/dashboard/logs/:filenametail?Read log file, optional last N lines

Audit ​

MethodPathParamsDescription
GET/api/dashboard/auditlimit?, offset?, trigger?Paginated audit traces (max 200)

Usage Tracking ​

MethodPathParamsDescription
GET/api/dashboard/usageUsage summary (costs, tokens)
GET/api/dashboard/usage/recordslimit?, offset?, model?Paginated records (max 200)

TODOs ​

MethodPathDescription
GET/api/dashboard/todosParse TODO.md items with completion stats
PUT/api/dashboard/todos/:idToggle todo completion. Body: { completed? }