API Reference

All endpoints are on the same port as the dashboard. Useful for scripting or integrating with other tools.

Note

If authentication is enabled, API requests require a Bearer token header: Authorization: Bearer YOUR_TOKEN

Endpoints

GET /health

curl http://localhost:4900/health

GET /agent/status

curl http://localhost:4900/agent/status

Pauses the agent on its next tool call.

POST /agent/:agent_id/hold

curl -X POST http://localhost:4900/agent/AGENT_ID/hold

Resumes a held agent.

POST /agent/:agent_id/release

curl -X POST http://localhost:4900/agent/AGENT_ID/release

Makes the agent check in after a set number of tool calls.

POST /agent/:agent_id/threshold
Content-Type: application/json

{"threshold": 5}

# Check in every 5 tools
curl -X POST http://localhost:4900/agent/AGENT_ID/threshold \
  -H "Content-Type: application/json" -d '{"threshold": 5}'

POST /agent/:agent_id/threshold
Content-Type: application/json

{"threshold": null}

curl -X POST http://localhost:4900/agent/AGENT_ID/threshold \
  -H "Content-Type: application/json" -d '{"threshold": null}'

Permanently deletes the agent's transcript from disk.

DELETE /agent/:agent_id

curl -X DELETE http://localhost:4900/agent/AGENT_ID

The dashboard connects via WebSocket at ws://localhost:4900. Messages are JSON with the format:

{"type": "event_type", "agent_id": "...", "data": {...}}

Key event types: