Interrupt

Represents an interrupt that can pause agent execution for human-in-the-loop workflows.

Properties

readonly id: string;

Unique identifier for this interrupt.

readonly name: string;

User-defined name for the interrupt.

readonly optional reason?: JSONValue;

User-provided reason for raising the interrupt.

optional response?: JSONValue;

Human response provided when resuming the agent after an interrupt.

toJSON(): {
  id: string;
  name: string;
  reason?: JSONValue;
  response?: JSONValue;
};

Serializes the interrupt to a JSON-compatible object.

{
  id: string;
  name: string;
  reason?: JSONValue;
  response?: JSONValue;
}