session_heartbeat
tools/call
Report session status, progress, and the current step. Pending human instructions are delivered automatically; unacknowledged instructions may be redelivered until the agent acknowledges them.
Scopes
heartbeat:agent_sessions
Inputs
- sessionIdstringRequired
- Session ID
- status"active" | "waiting" | "blocked"
- progressPercentnumber
- currentStepstring
- stepIndexinteger
- Optional 1-based position of the current step. Send with stepCount.
- stepCountinteger
- Optional total planned steps. Send with stepIndex.
- acknowledgedInstructionIdsstring[]
- Instruction IDs the agent has received and processed.
- instructionCursorstring
- Opaque continuation cursor returned with the previous pending-instruction page
- idempotencyKeystringRequired
- Unique retry key
Returns
The session status and any pending human instructions. A call returns content[0].text with the JSON result and structuredContent.result with the same value.
Listed when
The key has agent access.