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.
Install the CrewAI AG-UI package
pip install ag-ui-crewai litellmGive useHumanInTheLoop tools to the model
A Flow makes its own model call, so it must pass the tools itself:
- Type the Flow on
CopilotKitState. A tool registered withuseHumanInTheLooparrives inself.state.copilotkit.actions. - Pass the actions as
tools, insidecopilotkit_stream, so the tool call reaches the browser as it streams. - The run ends when the model calls the tool. After the user answers,
CopilotKit runs the Flow again with the answer as the last message, with
role: "tool". Read it in the@start()step to decide what happens next.
from typing import Any, cast
from crewai.flow.flow import Flow, listen, start
from litellm import acompletion
from ag_ui_crewai import CopilotKitState, copilotkit_stream
class AgentState(CopilotKitState):
pass
class SampleAgentFlow(Flow[AgentState]):
@start()
async def check_for_user_feedback(self):
if not self.state.messages:
return
last_message = cast(Any, self.state.messages[-1])
# The result of the useHumanInTheLoop tool (SEND or CANCEL)
if last_message["role"] == "tool":
if last_message.get("content") == "SEND":
self.state.messages.append({
"role": "assistant",
"content": "✅ Great! Sending your essay via email.",
})
return
if last_message.get("content") == "CANCEL":
self.state.messages.append({
"role": "assistant",
"content": "❌ Okay, we can improve the draft. What would you like to change?",
})
return
@listen(check_for_user_feedback)
async def chat(self):
system_message = {
"role": "system",
"content": (
"You write essays. Use your tools to write an essay; "
"don't just write it in plain text."
),
}
response = await copilotkit_stream(
await acompletion(
reasoning_effort="none",
allowed_openai_params=["reasoning_effort"],
model="openai/gpt-6-luna",
messages=[system_message, *self.state.messages],
tools=self.state.copilotkit.actions,
stream=True,
)
)
self.state.messages.append(response.choices[0].message)Pause the Flow for useInterrupt
To pause at a fixed step in your code instead, decorate the step with
CrewAI's @human_feedback and the AG-UI feedback provider. The step's
return value is the interrupt payload. The listening step receives the
user's answer as a HumanFeedbackResult.
import json
from typing import Any
from crewai.flow import Flow, HumanFeedbackResult, human_feedback, listen, start
from ag_ui_crewai import CopilotKitState, agui_feedback_provider
class InterruptFlow(Flow[CopilotKitState]):
@start()
@human_feedback(
message="Choose a meeting time or cancel the request.",
llm=None,
provider=agui_feedback_provider,
)
async def request_schedule(self) -> dict[str, Any]:
# ... call the model, then return what the picker needs:
return {"topic": topic, "attendee": attendee, "slots": slots}
@listen("request_schedule")
async def confirm_schedule(self, result: HumanFeedbackResult) -> None:
feedback_text = result.feedback or ""
# A cancelled interrupt resumes with an empty feedback string.
cancelled = not feedback_text.strip()
feedback = {} if cancelled else json.loads(feedback_text)Register the endpoint so it emits standard AG-UI interrupts:
add_crewai_flow_fastapi_endpoint(
app,
interrupt_flow,
"/interrupt",
emit_interrupt_outcome=True,
enable_legacy_on_interrupt_event=False,
)For a Conversational Flow, pass these
two flags in addition to conversational=True. On the frontend, read the
payload from interrupt.metadata.crewai.output. See
src/agents/interrupt_flow.py for the full Flow.
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?