Pausing the Agent for Input
Pause an agent run mid-tool, hand control to a custom React component, and resume with the user's answer.
What is this?
Some agent steps need a person's answer before the run can continue, such as
approving a payment or picking a meeting time. useInterrupt pauses the run,
shows your React component, and resumes the run with the answer. How the pause
works depends on your agent framework.
This framework ships a first-class interrupt primitive that lets running
work suspend itself and hand control to the client: interrupt() in
LangGraph,
interrupts in AWS Strands,
a tool that returns suspend() in Mastra, or a @human_feedback step in a
CrewAI Flow.
The run is frozen server-side until the client resolves the interrupt with a
payload. Then the run resumes, and the agent receives that payload as the
answer.
CopilotKit's useInterrupt is the frontend half of that contract: it
subscribes to the paused run, renders whatever component you give it,
and calls the agent back with the user's answer.
When should I use this?
Reach for useInterrupt when the pause is a checkpoint in your
agent code where the code path must stop and wait for a human,
not an LLM-initiated tool call. Typical cases:
- A sensitive action (payments, irreversible writes) must be approved
- A required piece of state isn't known and can only be collected from the user
- The agent explicitly reaches an approval node in a longer workflow
- You want the server-side contract to be an interrupt that resumes with a payload
For LLM-initiated pauses where the model decides on the fly to ask
the user, prefer useHumanInTheLoop.
The backend: pause the run in your agent
useHumanInTheLoop: nothing to wire on the agent
The AG-UI Mastra adapter forwards each tool you register with
useHumanInTheLoop to the agent as a client tool. When the model calls
it, the run hands control to the browser, and the user's answer comes
back as the tool result. Do not declare the tool on the Mastra agent.
useInterrupt: return suspend() from a tool
A Mastra tool pauses with suspend(), not interrupt(). Declare a
suspendSchema for the payload your UI reads and a resumeSchema for
the answer it sends back. The @ag-ui/mastra bridge sends the pause to
the frontend as an AG-UI interrupt. When the user answers, Mastra runs
execute again with the answer in resumeData.
// Native interrupt backend for the `gen-ui-interrupt` + `interrupt-headless`
// cells (OSS-383). Unlike the old Strategy-B workaround (a frontend-only
// `schedule_meeting` satisfied by `useHumanInTheLoop`), this is a REAL Mastra
// suspend tool: the model calls `schedule_meeting`, the tool `suspend()`s with
// a time-picker payload, and the @ag-ui/mastra bridge maps that to an AG-UI
// interrupt (legacy `on_interrupt` CUSTOM event + the standard `RUN_FINISHED`
// interrupt-outcome, on by default in the v1 bridge). The frontend `useInterrupt`
// hook renders the picker and `resolve(...)`s, which resumes the run — the tool's
// `execute` is re-invoked with `resumeData` carrying the user's selection.
//
// Load-bearing (see the Mastra capability-map memory):
// - `return suspend(...)` DIRECTLY. `await suspend(); return x` completes the
// tool, so under fast streaming the agentic loop continues past the pause.
// - Resume needs instance `storage` (configured on `new Mastra({ storage })`)
// and the suspend-chunk runId — both handled by the bridge + src/mastra/index.ts.
import { createTool } from "@mastra/core/tools";
import { z } from "zod";
export interface InterruptTimeSlot {
label: string;
iso: string;
}
// Mirror of `src/app/demos/_shared/interrupt-fallback-slots.ts` so the backend
// supplies future-relative candidate slots inside the suspend payload (the
// frontend only falls back to its own generator if these are absent).
function atLocal(date: Date, hour: number, minute = 0): Date {
return new Date(
date.getFullYear(),
date.getMonth(),
date.getDate(),
hour,
minute,
0,
0,
);
}
function nextMonday(from: Date): Date {
const day = from.getDay();
let offset = (1 - day + 7) % 7;
if (offset <= 1) offset += 7;
const next = new Date(from);
next.setDate(from.getDate() + offset);
return next;
}
export function generateCandidateSlots(
now: Date = new Date(),
): InterruptTimeSlot[] {
const tomorrow = new Date(now);
tomorrow.setDate(now.getDate() + 1);
const monday = nextMonday(now);
const candidates: Array<[string, Date]> = [
["Tomorrow 10:00 AM", atLocal(tomorrow, 10)],
["Tomorrow 2:00 PM", atLocal(tomorrow, 14)],
["Monday 9:00 AM", atLocal(monday, 9)],
["Monday 3:30 PM", atLocal(monday, 15, 30)],
];
return candidates.map(([label, date]) => ({
label,
iso: date.toISOString(),
}));
}
export const scheduleMeetingInterruptTool = createTool({
id: "schedule_meeting",
description:
"Ask the user to pick a meeting time. Surfaces an interactive time-picker " +
"to the user and returns their selection. Call this whenever the user asks " +
"to book or schedule a meeting.",
inputSchema: z.object({
topic: z
.string()
.describe("What the meeting is about (e.g. 'Intro with sales')."),
attendee: z
.string()
.optional()
.describe("Who the meeting is with (e.g. 'Alice'), if known."),
}),
suspendSchema: z.object({
topic: z.string(),
attendee: z.string().optional(),
slots: z.array(z.object({ label: z.string(), iso: z.string() })),
}),
resumeSchema: z.object({
chosen_time: z.string().optional(),
chosen_label: z.string().optional(),
cancelled: z.boolean().optional(),
}),
// Mastra createTool execute signature is `(inputData, executionContext)`:
// the validated INPUT is the first arg; the ToolExecutionContext is the
// second. `suspend` / `resumeData` live under `executionContext.agent`
// (the `AgentToolExecutionContext` sub-object), NOT at the top level.
// Destructuring them off `executionContext` directly yields `undefined`, so
// `return suspend(...)` throws `suspend is not a function`; the model gets a
// tool-error, re-calls, and the loop spins to the step cap with no
// `tool-call-suspended` chunk. Mirrors the proven @ag-ui/mastra dojo tool.
execute: async (inputData, executionContext) => {
const { suspend, resumeData } = executionContext?.agent ?? {};
// Second pass: the user resolved the interrupt — the run resumes here with
// their selection. Return a short confirmation the agent narrates.
if (resumeData) {
if (resumeData.cancelled) {
return "The user cancelled — no meeting was scheduled.";
}
const when =
resumeData.chosen_label ?? resumeData.chosen_time ?? "the chosen time";
return `Scheduled "${inputData.topic}" for ${when}.`;
}
// First pass: suspend with the picker payload. Returned directly so the
// agentic loop pauses here instead of continuing.
return suspend?.({
topic: inputData.topic,
attendee: inputData.attendee,
slots: generateCandidateSlots(),
});
},
});Two details fail without an error:
suspendandresumeDataare onexecutionContext.agent, the second argument ofexecute. Read from the top level of the context, they areundefined, and the model retries the tool until the run reaches its step limit.return suspend(...)directly. Withawait suspend()followed by anotherreturn, the tool completes and the agent keeps going past the pause.
Give the Mastra instance storage
Resume reloads the paused run from storage, so the Mastra instance that
registers the agent needs storage:
import { Mastra } from "@mastra/core/mastra";
import { LibSQLStore } from "@mastra/libsql";
export const mastra = new Mastra({
agents: { interruptAgent },
storage: new LibSQLStore({
id: "mastra-storage",
url: ":memory:",
}),
});Read the payload under suspendPayload
The bridge wraps your suspend() value, so useInterrupt does not
receive it as is:
- In the custom-event flow,
event.valueis a JSON string. Parse it and readsuspendPayload. - In the standard AG-UI flow, the payload is in
interrupt.metadata.mastra.suspendPayload.
useInterrupt({
render: ({ interrupt, event, resolve }) => {
const payload = interrupt
? interrupt.metadata?.mastra?.suspendPayload
: JSON.parse(event.value).suspendPayload;
return (
<div>
<p>Pick a time for {payload?.topic}</p>
<button onClick={() => resolve({ chosen_time: "Tomorrow 10:00 AM" })}>
Tomorrow 10:00 AM
</button>
<button onClick={() => resolve({ cancelled: true })}>Cancel</button>
</div>
);
},
});Whatever you pass to resolve(...) arrives in the tool as resumeData,
so shape it to match the tool's resumeSchema.
In the tool or step that needs the user's answer, call your framework's
interrupt primitive with the data your UI needs: interrupt() in LangGraph,
suspend() in Mastra, or a @human_feedback step in a CrewAI Flow. The
example agent does this in its schedule_meeting tool:
/**
* Scheduling agent for the interrupt-adapted demos (gen-ui-interrupt,
* interrupt-headless).
*
* This agent powers the NATIVE interrupt path (OSS-383). The backend
* `schedule_meeting` tool `suspend()`s with a time-picker payload; the
* @ag-ui/mastra v1 bridge maps that to an AG-UI interrupt (legacy
* `on_interrupt` CUSTOM event + the standard `RUN_FINISHED` interrupt-outcome,
* on by default). The frontend `useInterrupt` (gen-ui-interrupt, in-chat) /
* hand-rolled headless subscription (interrupt-headless, app-surface) renders
* the picker and resolves it, which resumes the run — re-invoking the tool's
* `execute` with `resumeData`. Replaces the prior `useHumanInTheLoop`
* frontend-tool workaround.
*
* Resume requires instance `storage` (see src/mastra/index.ts) so the
* suspended agentic-loop snapshot can be reloaded.
*/
export const interruptAgent = new Agent({
id: "interrupt-agent",
name: "Interrupt Agent",
tools: { schedule_meeting: scheduleMeetingInterruptTool },
model: openai("gpt-6-luna"),
instructions: `You are a scheduling assistant. Whenever the user asks you to book a call or schedule a meeting, you MUST call the \`schedule_meeting\` tool. Pass a short \`topic\` describing the purpose of the meeting and, if known, an \`attendee\` describing who the meeting is with.
The \`schedule_meeting\` tool surfaces an interactive time-picker to the user and pauses until they pick a slot (or cancel), then returns their selection to you. After it returns, briefly confirm whether the meeting was scheduled and at what time, or note that the user cancelled. Do NOT ask for approval yourself — always call the tool and let the picker handle the decision.
Keep responses short and friendly. After you finish executing tools, always send a brief final assistant message summarizing what happened so the message persists.`,
memory: new Memory({
storage: new LibSQLStore({
id: "interrupt-agent-memory",
url: WORKING_MEMORY_DB_URL,
}),
options: {
workingMemory: {
enabled: true,
schema: AgentState,
},
},
}),
});The run stops here until the client resolves the interrupt. The resolve
payload comes back to the agent as the answer: the return value of
interrupt() in LangGraph, resumeData in Mastra, or the
HumanFeedbackResult that the next step of a CrewAI Flow receives. The
example turns that value into a string for the model.
Two things to note:
- The payload (
{"topic": topic, "attendee": attendee}) is what the frontend reads off the interrupt. Keep it a plain, serializable object. It's the "pause-time context" the UI needs to render. - The return-side contract (
{chosen_label, chosen_time}or{cancelled: true}) is entirely yours. The client can send anything as the resolve payload; the tool is the one that gives it meaning.
The frontend: useInterrupt render prop
On the client you register a useInterrupt hook per agent. When the
paused run arrives, render receives both the raw event and the
interrupt itself, and resolve(...) is how you resume the run. Your agent
framework decides where the payload sits:
- Custom-event interrupt (
on_interrupt):event.value. - Standard AG-UI interrupt:
interrupt.metadata, or a JSON string ininterrupt.message.
import {
CopilotKit,
CopilotChat,
useInterrupt,
} from "@copilotkit/react-core/v2";
import type { TimeSlot } from "./_components/time-picker-card";
import { TimePickerCard } from "./_components/time-picker-card";
import { generateFallbackSlots } from "../_shared/interrupt-fallback-slots";
import { useGenUiInterruptSuggestions } from "./suggestions";
export default function GenUiInterruptDemo() {
return (
<CopilotKit runtimeUrl="/api/copilotkit" agent="gen-ui-interrupt">
<div className="flex justify-center items-center h-screen w-full">
<div className="h-full w-full max-w-4xl">
<Chat />
</div>
</div>
</CopilotKit>
);
}
// Shape the backend `schedule_meeting` tool suspends with (its suspendSchema),
// wrapped by the @ag-ui/mastra bridge under `mastra_suspend`.
type SuspendPayload = {
topic?: string;
attendee?: string;
slots?: TimeSlot[];
};
function Chat() {
useGenUiInterruptSuggestions();
// Native interrupt path (OSS-383). The backend `schedule_meeting` tool
// `suspend()`s; the @ag-ui/mastra bridge surfaces that as an AG-UI interrupt
// and `useInterrupt` renders the picker inline. `resolve(...)` resumes the
// Mastra run (re-invoking the tool's `execute` with the selection as
// `resumeData`).
useInterrupt({
agentId: "gen-ui-interrupt",
renderInChat: true,
render: ({ event, resolve }) => {
// Mastra wraps the suspend value as
// `{ type: "mastra_suspend", toolName, suspendPayload, ... }` and the
// AG-UI adapter JSON-stringifies it — parse, then read `suspendPayload`
// (NOT the raw value, which is the wrapper).
const raw = event.value ?? {};
const parsed = (typeof raw === "string" ? JSON.parse(raw) : raw) as {
suspendPayload?: SuspendPayload;
} & SuspendPayload;
const payload: SuspendPayload = parsed.suspendPayload ?? parsed;
const slots =
payload.slots && payload.slots.length > 0
? payload.slots
: generateFallbackSlots();
return (
<TimePickerCard
topic={payload.topic ?? "a call"}
attendee={payload.attendee}
slots={slots}
onSubmit={(result) => {
// Defer resolve so React commits the picked/cancelled badge before
// useInterrupt clears the interrupt element (a single rAF is not
// reliable — it can fire before React's commit).
setTimeout(() => resolve(result), 500);
}}
/>
);
},
});Whatever you pass to resolve is sent back to the agent as the answer to
the matching interrupt, for example the return value of interrupt(...) in
LangGraph.
Ask the agent to book a call. The time picker appears in the chat. Pick a slot, and the agent confirms the booked time.
Key props
agentId: must match a runtime-registered agent. If omitted, the hook uses the agent of the surrounding chat configuration, then theagentIdset onCopilotKitProvider, then"default". A mismatch means the interrupt never fires.render: receives{ event, interrupt, resolve }.renderInChat: whentrue(as above), the picker appears inline in the chat transcript, between the paused assistant turn and the still-pending continuation. To show it outside the chat, see Headless interrupts.
Multiple interrupts? Add a type and gate with enabled
If your agent issues more than one kind of interrupt (e.g. "ask" vs
"approval"), tag each with a type field on the payload and install
one useInterrupt per shape, each gated by an enabled predicate:
// The LangGraph adapter sends `event.value` as a JSON string.
const readValue = (value: unknown) =>
typeof value === "string" ? JSON.parse(value) : value;
useInterrupt({
agentId: "gen-ui-interrupt",
enabled: (event) => readValue(event.value).type === "ask",
render: ({ event, resolve }) => (
<AskCard question={readValue(event.value).content} onAnswer={resolve} />
),
});
useInterrupt({
agentId: "gen-ui-interrupt",
enabled: (event) => readValue(event.value).type === "approval",
render: ({ event, resolve }) => (
<ApproveCard content={readValue(event.value).content} onAnswer={resolve} />
),
});Preprocess with handler
For cases where the interrupt can sometimes be resolved without user
input (e.g. the current user already has permission), pass a handler
that runs before render. The handler can call resolve(...) itself
to resume the agent early. The interrupt card unmounts when the resume
run starts. Or return a value that render receives as result:
useInterrupt({
agentId: "gen-ui-interrupt",
handler: async ({ event, resolve }) => {
const value =
typeof event.value === "string" ? JSON.parse(event.value) : event.value;
const dept = await lookupUserDepartment();
if (value.accessDepartment === dept || dept === "admin") {
resolve({ code: "AUTH_BY_DEPARTMENT" });
return; // agent will resume; card unmounts when the run starts
}
return { dept };
},
render: ({ result, event, resolve }) => (
<RequestAccessCard
dept={result?.dept}
onRequest={() => resolve({ code: "REQUEST_AUTH" })}
onCancel={() => resolve({ code: "CANCEL" })}
/>
),
});AG-UI standard interrupt flow vs. custom-event flow
This section is a reference for developers who write render code for their
own agent. The useInterrupt reference lists
every option. useInterrupt handles two kinds of interrupt, and your agent
framework decides which kind it sends.
Standard flow (RUN_FINISHED with outcome.type === "interrupt")
When the agent backend conforms to the AG-UI protocol, it signals an interrupt
by emitting a RUN_FINISHED event whose outcome carries the interrupts array:
outcome.type === "interrupt"
outcome.interrupts // Interrupt[]The hook detects this on onRunFinishedEvent and exposes the interrupts on the
render props after onRunFinalized fires. Your render function receives:
interrupt: the primaryInterrupt(interrupts[0]), with shape{ id, reason, message?, toolCallId?, responseSchema?, expiresAt?, metadata? }.interrupts: the full open set (usually one, but multi-interrupt is supported, as described below).resolve(payload?, interruptId?): records{ status: "resolved", payload }for the targeted interrupt (defaults to the primary). The agent run resumes once every open interrupt has a response.cancel(interruptId?): records{ status: "cancelled" }for the targeted interrupt. Same accumulate-then-submit logic applies.
Each resume entry carries the interrupt id, the status, and your payload.
resolve and cancel send no metadata.
Custom-event flow (on_interrupt)
Agents that emit a custom on_interrupt event use this flow. The LangGraph
adapter emits this event by default. The hook detects this on onCustomEvent and sets
interrupt to null and interrupts to []. The payload is in
event.value. Calling resolve(payload) resumes via forwardedProps.command
(the custom-event resume mechanism). cancel() dismisses the interrupt without
resuming. The agent never receives a response.
Priority
If both signals appear on the same run, the standard flow wins.
Approve / Cancel example
function ApprovalInterrupt() {
useInterrupt({
render: ({ interrupt, resolve, cancel }) => (
<div className="p-3 border rounded">
<p>{interrupt?.message ?? "Approve this action?"}</p>
<div className="mt-2 flex gap-2">
<button onClick={() => resolve({ approved: true })}>Approve</button>
<button onClick={() => cancel()}>Cancel</button>
</div>
</div>
),
});
return null;
}resolve({ approved: true }) records a resolved entry and submits the resume
array to the agent. cancel() records a cancelled entry and does the same.
Both return the RunAgentResult once the run restarts.
Multi-interrupt behavior
Some agents issue more than one interrupt in a single run (e.g. two independent
approvals). Each interrupt has its own id. Address them individually:
useInterrupt({
render: ({ interrupts, resolve, cancel }) => (
<ul>
{interrupts.map((i) => (
<li key={i.id}>
{i.message}
<button onClick={() => resolve({ ok: true }, i.id)}>Approve</button>
<button onClick={() => cancel(i.id)}>Cancel</button>
</li>
))}
</ul>
),
});The agent run only resumes once every open interrupt has been addressed.
Calling resolve or cancel with a specific interruptId marks that interrupt
done; the hook auto-submits the accumulated responses when the last one is
addressed. If you omit interruptId, the primary interrupt (interrupts[0])
is targeted.
responseSchema: surface only, no client-side validation
The Interrupt type exposes a responseSchema field (a JSON Schema object)
that the agent can use to describe the expected payload shape. useInterrupt
surfaces this field on interrupt.responseSchema for your UI to read
(e.g. to drive a form), but it does not validate resolve payloads against
it. Validation is the agent's responsibility on resume.
How is this guide?