Sessions

session.stop()

Stop the current Session turn and cancel queued prompts that have not been merged yet

session.stop()

Use session.stop() to stop the current running turn.

const turn = await session.prompt({
  query: "Run a long task",
});

const stopResult = await session.stop();
await turn.finished;

stop() aborts the active turn and cancels queued prompts that have not yet been merged into that turn.

type AgentSessionStopResult = {
  stopped: boolean;
  turnId?: string;
  cancelledQueuedPrompts: number;
  reason: "stopped" | "idle";
};

Stopped turns finish with success: false. turn.finished still resolves rather than rejecting.

Table of Contents