HITL Overview

Allow your agent and users to collaborate on complex tasks.

Human In the Loop: In-chat

Waking up the demo

See this in Inspector

Open Inspector on localhost. Go to Inspect, then Frontend Tools. Your tool and its schema are listed.

More detail: Inspector.

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's what turns an autonomous workflow into a collaborative one: the agent keeps its context, 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 domain knowledge the model lacks.

Two patterns for HITL in CopilotKit

CopilotKit ships two complementary ways to pause an agent turn and ask the human something. They look similar from the outside (the chat pauses, a custom component appears, the user answers, the run resumes) but they're wired differently on the backend, and each has its own niche.

PatternWho decides to pause?Backend surface
useHumanInTheLoopThe LLM, by calling a registered client-side toolA frontend-only tool description (Zod 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 pause is an agent-initiated decision (the model chose to ask the user) and you want the picker UI inlined into the normal tool-call flow.

Pick useInterrupt when the pause is a checkpoint in your agent code: the code path always requires 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 OpenAI Agents AG-UI adapter

pip install ag-ui-openai-agents openai-agents

Ask for the human with a frontend tool

The simplest route is an ordinary frontend tool. Register it in the browser with useHumanInTheLoop, or with useFrontendTool and an async handler that resolves once the user has answered. The adapter hands the tool to the model on every run. When the model calls it, the run stops and the browser asks the user. The answer goes back with the next request as the call's result, and the model continues from there. Nothing waits on the server in between.

Name the tool in the agent's instructions

That leaves the agent with one job: knowing the tool exists and when to call it. A model that is never told about book_call will answer in prose and the picker will never mount.

hitl.py
from agents import Agent

from demo_agents._common import MODEL, chat_settings

HITL_IN_CHAT_PROMPT = (
    "You help users book an onboarding call with the sales team. "
    "When they ask to book a call, call the frontend-provided "
    "`book_call` tool with a short topic and the user's name. "
    "Keep any chat reply to one short sentence."
)


hitl_in_chat_agent = Agent(
    name="booking_assistant",
    instructions=HITL_IN_CHAT_PROMPT,
    model=MODEL,
    model_settings=chat_settings(),
)

Or gate a server tool with needs_approval

When the backend decides it needs the user, mark the tool needs_approval=True. The SDK pauses before the tool runs, and the adapter ends the AG-UI run with an interrupt for that call, which useInterrupt renders. The interrupt's reason is "tool_approval", its metadata carries tool_name and the parsed tool_input, and it asks for {"approved": boolean}.

interrupt_agent.py
@function_tool(needs_approval=True)
def schedule_meeting(ctx: ToolContext[Any], topic: str, attendee: str = "") -> str:
    """Ask the user to pick a meeting time, then confirm what was scheduled.

    Args:
        topic: Short description of the meeting purpose.
        attendee: Who the meeting is with, if known.
    """
    # Runs once the user approved, with the time they picked beside it.
    answer = _answers.get({}).get(ctx.tool_call_id, {})
    label = answer.get("chosen_label") or answer.get("chosen_time")
    if not label:
        return f"User did not pick a time. Meeting NOT scheduled: {topic}"
    return f"Meeting scheduled for {label}: {topic}"

The next request resumes the interrupt. {"approved": true} runs the tool before the model is called again. Any other answer gives the model the SDK's rejection text, and a cancelled interrupt answers the call as cancelled. If the user sends a new message instead of deciding, the approval stays open: the run ends with the same interrupt again, and the new message reaches the model once the approval is decided.

Hand the tool more than a yes or no

An Agents SDK approval is only a yes or a no, so an approved tool runs with its own arguments and nothing else. The showcase's picker sends the chosen time beside approved. A small OpenAIAgentsAgent subclass keeps each request's answers, by tool call id, where schedule_meeting can read them:

interrupt_agent.py
class SchedulerAgent(OpenAIAgentsAgent):
    """Lets ``schedule_meeting`` read the time the user picked.

    The adapter runs an approved call with its arguments alone: an Agents SDK
    approval is a yes or a no, with nothing to hand the tool. The picker
    sends the time beside the approval, so this keeps each answer where the
    tool can read it.
    """

    async def run_streamed(self, input: RunAgentInput) -> AsyncIterator[BaseEvent]:
        _answers.set(
            {
                entry.interrupt_id: entry.payload
                for entry in input.resume or []
                if isinstance(entry.payload, dict)
            }
        )
        async with aclosing(super().run_streamed(input)) as events:
            async for event in events:
                yield event

Nothing is kept on the server

The paused call lives in the conversation the page holds, and the server trusts the history it is sent. Replaying the same resume request runs an approved tool again, so key side effects on ToolContext.tool_call_id where a retry must not repeat them, and authorize the decision yourself if that matters.

Pattern 1: useHumanInTheLoop (tool-based)

Register a HITL tool in your React app with useHumanInTheLoop. When the LLM calls that tool, CopilotKit routes the call through your render function, which shows a custom component and calls respond with the user's answer. The agent sees the answer as the tool result and continues from there.

page.tsx
import React from "react";
import {
  CopilotKit,
  CopilotChat,
  useHumanInTheLoop,
  useConfigureSuggestions,
} from "@copilotkit/react-core/v2";
import { z } from "zod";
import type { TimeSlot } from "./time-picker-card";
import { TimePickerCard } from "./time-picker-card";

const DEFAULT_SLOTS: TimeSlot[] = [
  { label: "Tomorrow 10:00 AM", iso: "2026-04-19T10:00:00-07:00" },
  { label: "Tomorrow 2:00 PM", iso: "2026-04-19T14:00:00-07:00" },
  { label: "Monday 9:00 AM", iso: "2026-04-21T09:00:00-07:00" },
  { label: "Monday 3:30 PM", iso: "2026-04-21T15:30:00-07:00" },
];

export default function HitlInChatDemo() {
  return (
    <CopilotKit runtimeUrl="/api/copilotkit" agent="hitl-in-chat">
      <div className="flex justify-center items-center h-screen w-full">
        <div className="h-full w-full max-w-4xl">
          <Chat />
        </div>
      </div>
    </CopilotKit>
  );
}

function Chat() {
  useConfigureSuggestions({
    suggestions: [
      {
        title: "Book a call with sales",
        message:
          "Please book an intro call with the sales team to discuss pricing.",
      },
      {
        title: "Schedule a 1:1 with Alice",
        message: "Schedule a 1:1 with Alice next week to review Q2 goals.",
      },
    ],
    available: "always",
  });

  useHumanInTheLoop({
    agentId: "hitl-in-chat",
    name: "book_call",
    description:
      "Ask the user to pick a time slot for a call. The picker UI presents fixed candidate slots; the user's choice is returned to the agent.",
    parameters: z.object({
      topic: z
        .string()
        .describe("What the call is about (e.g. 'Intro with sales')"),
      attendee: z
        .string()
        .describe("Who the call is with (e.g. 'Alice from Sales')"),
    }),
    render: ({ args, status, respond }: any) => (
      <TimePickerCard
        topic={args?.topic ?? "a call"}
        attendee={args?.attendee}
        slots={DEFAULT_SLOTS}
        status={status}
        onSubmit={(result) => respond?.(result)}
      />
    ),
  });

The sample imports TimePickerCard from its own file. The card renders the slots and calls onSubmit with the user's choice. These are its props:

time-picker-card.tsx
export interface TimePickerCardProps {
  topic: string;
  attendee?: string;
  slots: TimeSlot[];
  status: TimePickerStatus;
  onSubmit: (
    result: { chosen_time: string; chosen_label: string } | { cancelled: true },
  ) => void;
}

Each slot button calls onSubmit({ chosen_time: s.iso, chosen_label: s.label }). The "None of these work" button calls onSubmit({ cancelled: true }). The full file is in the Code view of the demo at the top of this page.

The picker UI is fed a static list of candidate slots. This is just data the demo page owns, so you can swap in real availability, a calendar API, or anything else:

page.tsx
import React from "react";
import {
  CopilotKit,
  CopilotChat,
  useHumanInTheLoop,
  useConfigureSuggestions,
} from "@copilotkit/react-core/v2";
import { z } from "zod";
import type { TimeSlot } from "./time-picker-card";
import { TimePickerCard } from "./time-picker-card";

const DEFAULT_SLOTS: TimeSlot[] = [
  { label: "Tomorrow 10:00 AM", iso: "2026-04-19T10:00:00-07:00" },
  { label: "Tomorrow 2:00 PM", iso: "2026-04-19T14:00:00-07:00" },
  { label: "Monday 9:00 AM", iso: "2026-04-21T09:00:00-07:00" },
  { label: "Monday 3:30 PM", iso: "2026-04-21T15:30:00-07:00" },
];

Pattern 2: useInterrupt (agent-paused)

With an interrupt, your agent code enforces the pause, for example with LangGraph's interrupt():

  1. A node calls interrupt({...}), and the run stops.
  2. The client 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.

See the useInterrupt deep dive for the full walkthrough, including the backend tool and render-prop wiring.

Human in the Loop: Interrupts

Waking up the demo

Going headless

Both patterns above ship with a render prop. CopilotKit handles the "when to show the picker" logic for you. If you want to drive interrupt resolution from a custom UI that lives anywhere in the tree (not necessarily inside a chat), see the headless interrupts guide. It shows how to compose useAgent, agent.subscribe, and copilotkit.runAgent to build your own useInterrupt equivalent.

How is this guide?