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.

PatternWho decides to pause?Backend surface
useHumanInTheLoopThe LLM, by calling a tool your app registeredA frontend-only tool (schema + render)
useInterruptYour agent code, at a step that must stop for a personAn 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: no frontend-tool code on the agent

AGUIStream turns every tool the client declares into a client-side tool, so a tool you register with useHumanInTheLoop reaches the model through the AG-UI request. Do not declare it on the AG2 agent. Name it in the agent's prompt so the model calls it.

To keep the user's answer, have a backend tool write it to context.variables. When a tool changes the variables, AGUIStream sends a STATE_SNAPSHOT at the end of the run:

agent.py
from typing import Annotated

from fastapi import FastAPI, Header
from fastapi.responses import StreamingResponse
from pydantic import Field

from ag2 import Agent, Context, tool
from ag2.ag_ui import AGUIStream, RunAgentInput
from ag2.config import OpenAIResponsesConfig

@tool
def store_user_choice(
    choice: Annotated[str, Field(description="The option selected by the user")],
    context: Context,
) -> str:
    """Store the latest user choice in shared state."""
    context.variables["hitl"] = {"latest_choice": choice}
    return f"Stored choice: {choice}"

agent = Agent(
    name="assistant",
    prompt=(
        "When you need the user to choose, call the frontend tool `offerOptions`. "
        "After it returns, call `store_user_choice` with the selected value."
    ),
    config=OpenAIResponsesConfig(model="gpt-6-luna"),
    tools=[store_user_choice],
)

stream = AGUIStream(agent)
app = FastAPI()

@app.post("/chat")
async def run_agent(
    message: RunAgentInput,
    accept: str | None = Header(None),
) -> StreamingResponse:
    return StreamingResponse(
        stream.dispatch(message, accept=accept),
        media_type=accept or "text/event-stream",
    )

Approve a tool call with interrupts

AG2 can also pause a run on the backend. A tool wrapped in ApprovalRequired is held until the user approves or rejects the call. AG2 sends the held call to the client as an AG-UI interrupt, and CopilotKit's useInterrupt renders it.

tools.py
from typing import Annotated

from pydantic import Field

from ag2 import Context, tool
from ag2.middleware.builtin.tools.approval import ApprovalRequired

@tool(
    description="Save a city to the user's favorites. The user confirms before anything is saved.",
    middleware=[
        ApprovalRequired("Save this city to your favorites?\n{tool_arguments}", allow_always=False)
    ],
)
async def save_favorite_city(
    context: Context,
    city: Annotated[str, Field(description="The city name to save, e.g. 'Lisbon'")],
) -> list[str]:
    favorites = list(context.variables.get("favorites", []))
    if city not in favorites:
        favorites.append(city)
    context.variables["favorites"] = favorites
    return favorites

Serve the agent with AGUIStream as usual. Do not set a hitl_hook on the agent. With one, AG2 asks in-process and no interrupt reaches the browser.

The run ends with an interrupt of reason tool_call. The backend reads the answer as a boolean, so resolve(true) approves the call and resolve(false) refuses it. A refusal does not fail the run: the model is told the call was refused and carries on.

page.tsx
import { useInterrupt } from "@copilotkit/react-core/v2";

export function Page() {
  useInterrupt({
    render: ({ interrupt, resolve }) => (
      <div>
        <p>{interrupt?.message ?? "The assistant needs your confirmation."}</p>
        <button onClick={() => resolve(true)}>Approve</button>
        <button onClick={() => resolve(false)}>Reject</button>
      </div>
    ),
  });

  // ...
}

Ask Save Lisbon to my favorites. The approval card appears in the chat. Approve it, and the city shows up in the shared state.

useInterrupt().resolve() and .cancel() send no metadata in the resume entry. That is enough for a gated tool call like the one above, but not for an AG2 server built with require_resume_proof=True, which needs the interrupt's metadata copied into the resume entry. See Asking the human a question in the AG2 docs.

A held turn lives in the AG2 process that served the run, so the resuming run must reach that same process. See the AG2 deployment notes before you run several replicas.

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.

src/MeetingApproval.tsx
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():

  1. A step calls interrupt({...}), and the run stops.
  2. The app receives the payload and renders your UI.
  3. 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?