HITL Overview
Allow your agent and users to collaborate on complex tasks.
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.
| Pattern | Who decides to pause? | Backend surface |
|---|---|---|
useHumanInTheLoop | The LLM, by calling a registered client-side tool | A frontend-only tool description (Zod 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 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.
Declare the tool as an external tool
Agno's AG-UI interface does not forward the request's tool definitions to
the model. The model only sees tools declared on the Agent. A tool you
register with useHumanInTheLoop therefore needs a matching declaration
on the agent, marked external_execution=True, with an empty body. Agno
pauses the run, the browser renders your component, and the run resumes
with the user's answer.
The name and the arguments must match the useHumanInTheLoop
registration exactly. The docstring is what the model reads, so describe
when to call the tool there.
from agno.tools import tool
@tool(external_execution=True)
def offerOptions(option_1: str, option_2: str):
"""
Give the user a choice between two options and have them select one.
Args:
option_1: str: The first option
option_2: str: The second option
"""Register the tool on the agent:
from agno.agent import Agent
from agno.db.sqlite import SqliteDb
from agno.models.openai import OpenAIChat
from agno.os import AgentOS
from agno.os.interfaces.agui import AGUI
from tools.frontend import offerOptions
db = SqliteDb(db_file="tmp/agno.db")
agent = Agent(
model=OpenAIChat(reasoning_effort="none", id="gpt-6-luna"),
tools=[offerOptions],
db=db,
description="A helpful assistant that can answer questions and provide information.",
instructions="Be helpful and friendly. Format your responses using markdown where appropriate.",
)
agent_os = AgentOS(agents=[agent], interfaces=[AGUI(agent=agent)])
app = agent_os.get_app()
if __name__ == "__main__":
agent_os.serve(app="main:app", port=8000, reload=True)Give the agent somewhere to store the paused run
Agno stores the paused run before the browser can return the user's
answer, so the Agent that owns the external tool needs a database. An
agent with an external tool and no db cannot resume after the user
answers.
SqliteDb needs sqlalchemy installed:
pip install sqlalchemyA project-relative SQLite file, as above, is fine for local development.
For production, use durable shared storage such as PgDb. An ephemeral
container file cannot resume a run on another instance.
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.
import React from "react";
import {
CopilotKit,
CopilotChat,
useHumanInTheLoop,
useConfigureSuggestions,
} from "@copilotkit/react-core/v2";
import { z } from "zod";
import { TimePickerCard, TimeSlot } 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:
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:
import React from "react";
import {
CopilotKit,
CopilotChat,
useHumanInTheLoop,
useConfigureSuggestions,
} from "@copilotkit/react-core/v2";
import { z } from "zod";
import { TimePickerCard, TimeSlot } 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():
- A node calls
interrupt({...}), and the run stops. - The client 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.
See the useInterrupt deep dive for
the full walkthrough, including the backend tool and render-prop wiring.
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?