Skip to content

docs(api): document recoveryDisabled field on SessionInfo (#4802) #4805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aegis-gh-agent merged 1 commit into from
Jun 22, 2026
Merged

docs(api): document recoveryDisabled field on SessionInfo (#4802) #4805

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -864,12 +864,13 @@ curl http://localhost:9100/v1/sessions/abc123 \
-H "Authorization: Bearer $TOKEN"
```

**Response:** Session object with `actionHints` for current interactive state, `latestActivityText` for live agent activity, `ccSessionId` when correlated with a Claude Code session, and `telegramTopicId` when a Telegram topic is linked.
**Response:** Session object with `actionHints` for current interactive state, `latestActivityText` for live agent activity, `ccSessionId` when correlated with a Claude Code session, `telegramTopicId` when a Telegram topic is linked, and `recoveryDisabled` when stall auto-recovery is paused on this session.

| Field | Type | Description |
|-------|------|-------------|
| `latestActivityText` | string | Human-readable description of current agent activity (e.g. `"Running: npm test"`, `"Editing: server.ts"`, `"Idle"`, `"Waiting for input"`, `"Compacting context"`). Updated in real-time from CC hook events. |
| `ccSessionId` | string | Claude Code session ID correlated with this Aegis session via the `CLAUDE_CODE_SESSION_ID` environment variable. Only present when the CC→Aegis mapping has been established through MCP tool usage. |
| `recoveryDisabled` | boolean | Per-session kill-switch for stall auto-recovery. When `true`, Aegis will not auto-restart a stalled session — the operator has paused recovery. Persists across Aegis restarts. Only present when explicitly set (defaults to `false`). Currently toggled via the dashboard stall pill; no REST endpoint to set it directly. |

**Errors:**

Expand Down
Loading