HITL Overview
Let your agent and your React Native users work through tasks together.
What is this?
Human-in-the-loop (HITL) lets an agent pause mid-run to collect input, confirmation, or a choice from the user, then resume with that answer folded back into its reasoning. It turns an autonomous workflow into a collaborative one: the agent keeps its context, and the user keeps the steering wheel.
When should I use this?
Use HITL when you need:
- Quality control: a human gate at high-stakes decision points.
- Missing input: the agent needs a value only the user knows, such as a meeting time.
- Risky actions: the agent must get a yes before it sends, pays, or deletes.
- Expert input: the user supplies knowledge the model lacks.
Two patterns for HITL in CopilotKit
CopilotKit has two ways to pause an agent turn and ask the user something. They look alike from the outside (the chat pauses, your component appears, the user answers, the run resumes), but they're wired differently on the backend.
| Pattern | Who decides to pause? | Backend surface |
|---|---|---|
useHumanInTheLoop | The LLM, by calling a tool your app registered | A frontend-only tool (schema + render) |
useInterrupt | Your agent code, at a step that must stop for a person | An interrupt your agent emits, for example LangGraph interrupt() or Mastra suspend() |
Pick useHumanInTheLoop when the model decides to ask the user, and you want the question to appear in the normal tool-call flow.
Pick useInterrupt when the pause is a checkpoint in your agent code: that code path always needs a human answer, and the server-side contract is an interrupt. On the Built-in Agent, interrupts are temporarily unavailable, so use useHumanInTheLoop there.
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.
Pattern 1: useHumanInTheLoop (tool-based)
Register a HITL tool with useHumanInTheLoop. When the model calls it, CopilotKit renders your component for the call. While the call is running, the component gets a respond callback. The agent receives the answer as the tool result and continues from there.
import { Pressable, Text, View } from "react-native";
import { useHumanInTheLoop } from "@copilotkit/react-native/headless";
import { z } from "zod";
const SLOTS = [
{ iso: "2026-11-17T09:00:00Z", label: "Tue 9 AM" },
{ iso: "2026-11-18T14:00:00Z", label: "Wed 2 PM" },
];
export function useMeetingApproval() {
useHumanInTheLoop({
name: "schedule_meeting",
description: "Ask the user to pick a meeting time.",
parameters: z.object({
topic: z.string(),
attendee: z.string(),
}),
render: ({ args, respond, result }) => (
<View style={{ padding: 12, borderRadius: 12, backgroundColor: "#f4f4f8", gap: 8 }}>
<Text style={{ fontWeight: "600" }}>
Pick a time for {args.topic ?? "the meeting"}
</Text>
{result ? (
<Text>Done: {result}</Text>
) : (
<>
{SLOTS.map((slot) => (
<Pressable
key={slot.iso}
disabled={!respond}
onPress={() => respond?.({ chosen_time: slot.iso, chosen_label: slot.label })}
>
<Text>{slot.label}</Text>
</Pressable>
))}
<Pressable disabled={!respond} onPress={() => respond?.({ cancelled: true })}>
<Text>None of these work</Text>
</Pressable>
</>
)}
</View>
),
});
}respond is set only while the call is running. Before that, the arguments are still streaming in, and args can be partial. After the user answers, result holds the tool result as a string.
Call useMeetingApproval() in a component under CopilotKitProvider. The slots are data your app owns, so you can swap in real availability or a calendar API.
Where the card renders
The rendered CopilotChat and CopilotModal from @copilotkit/react-native/components draw the card in the conversation. The root CopilotChat, CopilotPopup, and CopilotSidebar don't draw messages, so in your own chat, render tool calls with useRenderToolCall. See Headless UI.
Ask the agent to book a meeting with Alex about the launch. The card appears in the chat. Tap a slot, and the agent confirms the time you picked.
Pattern 2: useInterrupt (agent-paused)
With an interrupt, your agent code enforces the pause, for example with LangGraph's interrupt():
- A step calls
interrupt({...}), and the run stops. - The app receives the payload and renders your UI.
- The user answers, and the run resumes with the answer.
CopilotKit's useInterrupt hook is the render contract. The rendered CopilotChat from /components draws its element after the last message.
See the useInterrupt deep dive for the full walkthrough, including the backend and the render callback.
Going headless
Both patterns can drive UI outside the chat. For interrupts, set renderInChat: false and place the element that useInterrupt returns. For a tool-based pause, a frontend tool's Promise can drive your own app state. See the headless interrupts guide.
How is this guide?