Pausing the Agent for Input
Pause an agent run, hand control to a React Native 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 Native component, and resumes the run with the answer. How the pause works depends on your agent framework.
Your agent framework has a native pause primitive, such as LangGraph's interrupt(). A running step suspends itself and hands control to the app. The run stays frozen on the server until the app answers with a payload. Then the step resumes as if interrupt() had returned that payload.
CopilotKit's useInterrupt is the frontend half of that contract: it receives the paused run, renders your UI, and resumes the agent with the user's answer.
When should I use this?
Use useInterrupt when the pause is a checkpoint in your agent code, where the code path must stop and wait for a human. It is not for a tool call the model decides to make. Typical cases:
- A sensitive action (payments, irreversible writes) must be approved
- A required value isn't known and only the user can give it
- The agent reaches an approval step in a longer workflow
- You want the server-side contract to be an interrupt that resumes with a payload
When the model decides on the fly to ask the user, use useHumanInTheLoop instead.
The backend: pause the run in your agent
Pause a tool with Strands' native interrupt
AWS Strands ships a first-class
interrupt primitive.
A tool's callback receives a context whose interrupt({ name, reason })
call halts the agent loop and hands reason to the client as the interrupt
payload. The AG-UI adapter finishes the run with RUN_FINISHED carrying
outcome.type === "interrupt".
export const scheduleMeeting = tool({
name: "schedule_meeting",
description:
"Ask the user to pick a meeting time, then confirm what was scheduled.",
inputSchema: z.object({
topic: z.string().describe("Short description of the meeting purpose."),
attendee: z.string().optional().describe("Who the meeting is with."),
}),
callback: ({ topic, attendee }, context) => {
// Typed optional by the SDK, so this is checked rather than asserted: with
// no context there is nothing to pause on, and pretending otherwise would
// schedule a meeting the user never saw.
if (!context) {
throw new Error("schedule_meeting needs a tool context to pause on");
}
// `attendee` is optional and the reason has to be JSON, which has no
// `undefined`, so it is omitted rather than sent as undefined.
const answer = context.interrupt<ResumeEnvelope>({
name: "schedule_meeting",
reason: attendee === undefined ? { topic } : { topic, attendee },
});
// Three cancel shapes reach here: each bridge's own sentinel for a
// cancelled resume entry, and the picker's Cancel button, which resolves
// with a `cancelled` flag inside the payload.
const { choice, cancelled } = readResume(answer);
if (cancelled) {
return `User cancelled. Meeting NOT scheduled: ${topic}`;
}
const label = choice.chosen_label || choice.chosen_time;
return label
? `Meeting scheduled for ${label}: ${topic}`
: `User did not pick a time. Meeting NOT scheduled: ${topic}`;
},
});How the answer reaches the tool depends on the adapter version. The pinned
@ag-ui/aws-strands 0.2.3 hands the client's payload through untouched and
signals a cancel as { status: "cancelled" }; the Python adapter wraps an
answer as { response: ... } and cancels with { cancelled: true }. Read
both shapes, or a picked slot comes back to the model as though the user
never picked one.
Keep the pausing tool off a client-executed name
useHumanInTheLoop registers its tool on the FRONTEND, so a name used
there cannot also be a pausing backend tool. This showcase mounts a
dedicated interrupt agent and points the interrupt demos' agent names at
it, leaving schedule_meeting on the shared agent free for the
frontend-tool flow.
Resume in the same process, or across a restart
Pause and resume on the same running process need no extra wiring. For a
resume that survives a restart, give the agent a Strands SessionManager
through StrandsAgentConfig.sessionManagerProvider; the adapter persists
its interrupt checkpoint into that session.
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. This agent does it in its schedule_meeting tool:
export const scheduleMeeting = tool({
name: "schedule_meeting",
description:
"Ask the user to pick a meeting time, then confirm what was scheduled.",
inputSchema: z.object({
topic: z.string().describe("Short description of the meeting purpose."),
attendee: z.string().optional().describe("Who the meeting is with."),
}),
callback: ({ topic, attendee }, context) => {
// Typed optional by the SDK, so this is checked rather than asserted: with
// no context there is nothing to pause on, and pretending otherwise would
// schedule a meeting the user never saw.
if (!context) {
throw new Error("schedule_meeting needs a tool context to pause on");
}
// `attendee` is optional and the reason has to be JSON, which has no
// `undefined`, so it is omitted rather than sent as undefined.
const answer = context.interrupt<ResumeEnvelope>({
name: "schedule_meeting",
reason: attendee === undefined ? { topic } : { topic, attendee },
});
// Three cancel shapes reach here: each bridge's own sentinel for a
// cancelled resume entry, and the picker's Cancel button, which resolves
// with a `cancelled` flag inside the payload.
const { choice, cancelled } = readResume(answer);
if (cancelled) {
return `User cancelled. Meeting NOT scheduled: ${topic}`;
}
const label = choice.chosen_label || choice.chosen_time;
return label
? `Meeting scheduled for ${label}: ${topic}`
: `User did not pick a time. Meeting NOT scheduled: ${topic}`;
},
});The run stops here until the app 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.
Two things to note:
- The payload (
{ "topic": topic, "attendee": attendee }) is what the app reads from the interrupt. Keep it a plain, serializable object with the context your UI needs. - The answer's shape (
{ chosen_label, chosen_time }or{ cancelled: true }) is up to you. The app can send any serializable payload, and the tool gives it meaning. Validate it in the tool before any side effect.
The frontend: useInterrupt in the rendered chat
Register useInterrupt in a component under CopilotKitProvider. When the paused run arrives, render receives the event, the interrupt, and resolve(...), which resumes the run. Your agent framework decides where the payload is:
- Custom-event interrupt (
on_interrupt): inevent.value. The LangGraph adapter sends it as a JSON string. - Standard AG-UI interrupt: in
interrupt.metadata, or as a JSON string ininterrupt.message.
import { Pressable, Text, View } from "react-native";
import { useInterrupt, type Interrupt } from "@copilotkit/react-native/headless";
import { CopilotChat } from "@copilotkit/react-native/components";
type MeetingPayload = { topic?: string; attendee?: string };
// Read the payload from either interrupt shape. JSON strings are parsed.
function readPayload(eventValue: unknown, interrupt: Interrupt | null): MeetingPayload {
const raw = interrupt ? (interrupt.metadata ?? interrupt.message) : eventValue;
if (typeof raw !== "string") return (raw ?? {}) as MeetingPayload;
try {
return JSON.parse(raw) as MeetingPayload;
} catch {
return {};
}
}
export function MeetingChat() {
useInterrupt({
agentId: "gen-ui-interrupt",
render: ({ event, interrupt, resolve }) => (
<View style={{ padding: 12, borderRadius: 12, backgroundColor: "#f4f4f8", gap: 8 }}>
<Text style={{ fontWeight: "600" }}>
Pick a time for {readPayload(event.value, interrupt).topic ?? "a call"}
</Text>
<Pressable
onPress={() => resolve({ chosen_label: "Tomorrow", chosen_time: "2026-11-11T09:00:00Z" })}
>
<Text>Tomorrow at 09:00</Text>
</Pressable>
<Pressable onPress={() => resolve({ cancelled: true })}>
<Text>Cancel</Text>
</Pressable>
</View>
),
});
return <CopilotChat agentName="gen-ui-interrupt" />;
}The rendered CopilotChat and CopilotModal from /components draw the element after the last message. Whatever you pass to resolve goes back to the agent as the answer to the matching interrupt.
Match the agent on both sides
The rendered chat picks its agent with agentName, and it doesn't pass that agent to the hooks around it. Without an agentId, useInterrupt listens to the agent named "default". Give useInterrupt the same agent as the chat, or the interrupt never appears.
Ask the agent to book a call. The picker appears in the chat. Tap Tomorrow at 09:00, and the agent confirms the time.
Key props
agentId: must match a runtime-registered agent. If you leave it out, the hook uses the agent of the surrounding chat configuration, then"default". The rootCopilotChatsets that configuration for its children. The rendered chat from/componentsdoesn't. A mismatch means the interrupt never appears.render: receives{ event, interrupt, interrupts, result, resolve, cancel }and returns a React Native element.renderInChat:trueby default, which hands the element to the rendered chat. Set it tofalseto get the element back from the hook and place it yourself. See Headless Interrupts.handler: runs beforerender. It can resolve the interrupt early, or return a value thatrenderreceives asresult.enabled: filters which interrupts this hook handles.
Multiple interrupts? Add a type and gate with enabled
If your agent issues more than one kind of interrupt, tag each payload with a type field and install one useInterrupt per shape, each gated by enabled:
// The LangGraph adapter sends `event.value` as a JSON string.
const readValue = (value: unknown): { type?: string; content?: string } =>
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} />
),
});AskCard and ApproveCard are your own components. For a standard interrupt, event.value is the primary Interrupt object, so read your tag from its metadata instead.
Preprocess with handler
When an interrupt can sometimes be answered without the user (for example, the current user already has permission), pass a handler. It runs before render. It can call resolve(...) to resume the agent early, 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 department = await lookupUserDepartment(); // your own lookup
if (value.accessDepartment === department || department === "admin") {
await resolve({ code: "AUTH_BY_DEPARTMENT" });
return;
}
return { department };
},
render: ({ result, resolve }) => (
<RequestAccessCard
department={result?.department}
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")
An agent that follows the AG-UI protocol signals an interrupt with a RUN_FINISHED event whose outcome carries the interrupts:
outcome.type === "interrupt"
outcome.interrupts // Interrupt[]The hook shows the interrupts after the run finalizes. render receives:
interrupt: the primaryInterrupt(interrupts[0]), with shape{ id, reason, message?, toolCallId?, responseSchema?, expiresAt?, metadata? }.interrupts: every open interrupt.resolve(payload?, interruptId?): records an answer for the targeted interrupt. The run resumes once every open interrupt has an answer.cancel(interruptId?): records a cancellation for the targeted interrupt. The run also resumes once every open interrupt is addressed.
Custom-event flow (on_interrupt)
Agents can emit a custom on_interrupt event. The LangGraph adapter does this by default. render gets its payload in event.value, with interrupt set to null and interrupts to []. resolve(payload) resumes the run right away, through forwardedProps.command. cancel() only dismisses the interrupt without resuming, because this flow has no cancel answer.
If both signals arrive on the same run, the standard flow wins.
Approve / Cancel example
import { Button, Text, View } from "react-native";
import { useInterrupt } from "@copilotkit/react-native/headless";
function ApprovalPanel() {
const element = useInterrupt({
renderInChat: false,
render: ({ interrupt, resolve, cancel }) => (
<View style={{ padding: 12, gap: 8 }}>
<Text>{interrupt?.message ?? "Approve this action?"}</Text>
<Button title="Approve" onPress={() => resolve({ approved: true })} />
<Button title="Cancel" onPress={() => cancel()} />
</View>
),
});
return element;
}Both methods return the run result once the run restarts, or nothing while other open interrupts still wait for an answer.
More than one open interrupt
Some agents issue more than one interrupt in a single run. Each has its own id, so answer them one by one:
render: ({ interrupts, resolve, cancel }) => (
<View>
{interrupts.map((item) => (
<View key={item.id} style={{ flexDirection: "row", gap: 8 }}>
<Text>{item.message}</Text>
<Button title="Approve" onPress={() => resolve({ ok: true }, item.id)} />
<Button title="Cancel" onPress={() => cancel(item.id)} />
</View>
))}
</View>
),The run resumes only after every open interrupt is addressed. If you leave out interruptId, the primary interrupt is targeted, and the hook logs a warning when several are open.
responseSchema is not validated
An Interrupt can carry a responseSchema, a JSON Schema that describes the answer the agent expects. useInterrupt passes it to render as interrupt.responseSchema, but it does not check your resolve payload against it. The agent validates the answer when it resumes.
Provider setup
The component that calls useInterrupt or useHumanInTheLoop must be under CopilotKitProvider:
import { CopilotKitProvider } from "@copilotkit/react-native/headless";
import { MeetingChat } from "./src/MeetingChat";
const runtimeUrl = "http://localhost:8200/api/copilotkit";
export default function App() {
return (
<CopilotKitProvider runtimeUrl={runtimeUrl}>
<MeetingChat />
</CopilotKitProvider>
);
}How is this guide?