AgentInterrupt
Unpublished development API. This package is under development and is not available as a published release.
One thing a paused run is waiting on, such as an approval or a missing
answer. A run that paused reports its interrupts in the snapshot and settles
with the 'paused' outcome; resume answers them.
import type { AgentInterrupt } from '@threadplane/core';Declaration
export interface AgentInterrupt {
readonly id: string;
readonly message?: string;
readonly reason?: string;
readonly toolCallId?: string;
readonly value?: PlainValue;
}Members
id
Names this interrupt in a response. Unique among the pending interrupts.
readonly id: string;message
Display text the backend supplied for the person answering.
readonly message?: string;reason
The kind of pause in the backend's own words, such as tool_approval.
readonly reason?: string;toolCallId
The tool call this pause is about, when the backend relates the two.
readonly toolCallId?: string;value
What the backend sent with the pause, as frozen plain data. Its shape belongs to the agent that paused, so a view narrows it before rendering.
readonly value?: PlainValue;