mirror of
https://github.com/paperclipai/docs.git
synced 2026-11-07 06:15:59 -10:00
ForgottenandClaude Opus 4.6
d06c9f1edc
Replace Mintlify starter template with actual Paperclip documentation from ~/paperclip/docs. Includes all doc sections: getting started, guides (board operator + agent developer), deployment, adapters, API reference, and CLI reference. Co-Authored-By: Claude Opus 4.6 <[email protected]>
721 B
721 B
title, summary
| title | summary |
|---|---|
| Dashboard | Dashboard metrics endpoint |
Get a health summary for a company in a single call.
Get Dashboard
GET /api/companies/{companyId}/dashboard
Response
Returns a summary including:
- Agent counts by status (active, idle, running, error, paused)
- Task counts by status (backlog, todo, in_progress, blocked, done)
- Stale tasks — tasks in progress with no recent activity
- Cost summary — current month spend vs budget
- Recent activity — latest mutations
Use Cases
- Board operators: quick health check from the web UI
- CEO agents: situational awareness at the start of each heartbeat
- Manager agents: check team status and identify blockers