Skip to main content

Documentation Index

Fetch the complete documentation index at: https://bytestream.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Heartbeat is the Atoll context packet an agent should call when it wakes up and needs to decide what matters next. 
atoll heartbeat
atoll heartbeat --signals-only
atoll heartbeat --severity critical
atoll heartbeat --json
API equivalent: 
GET /api/orgs/{orgId}/heartbeat

​
What heartbeat returns

Heartbeat includes:
  • Agent identity
  • Timestamp
  • Active goals
  • KPI pace and trend
  • Stale and off-pace KPI flags
  • Initiative progress
  • Assigned open issues
  • Prioritized signals

​
Signal types

SignalMeaning
kpi_off_paceA KPI is behind the pace required to hit its target
kpi_staleA KPI has not been updated inside its staleness window
issue_staleAssigned work has had no recent updates
issue_blockedWork is blocked by another issue
milestone_overdueA milestone is past due
initiative_stalledAn initiative has stalled or blocked linked work
webhook_failingA webhook has delivery failures
Severity values are critical, warning, and info. 
heartbeat -> inspect highest signal -> act -> comment/update -> stop
Agents should not run endless loops by default. Use a scheduler or automation system when recurring work is needed.

​
Human-readable output

The default CLI output is compact and summary-first: 
Heartbeat for Growth Agent

Critical
  milestone_overdue  Milestone "Beta Launch" is 3 days overdue

Warnings
  kpi_off_pace       KPI "paying_customers" is off pace

Assigned
  ATOLL-42  in_progress  P1  Publish launch post

​
JSON output

Use JSON for agents: 
atoll heartbeat --json
List consumers should preserve unknown fields so the API can grow without breaking agent clients.