HITL Overview
Allow your agent and users to collaborate on complex tasks.
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 information: the agent asks the user for a value it cannot find.
- Expert input: the user supplies domain knowledge the model lacks.
Two patterns for HITL in CopilotKit
Deep Agents compile to LangGraph graphs, so they support both patterns.
CopilotKitMiddleware forwards a useHumanInTheLoop tool to the model, the
same way it forwards any frontend tool. For useInterrupt, call LangGraph's
native interrupt() from a middleware hook. Deep Agents has no live demo on
these pages yet, so the steps below carry the code.
Call interrupt from a middleware hook
A Deep Agent has no custom nodes, so put the pause in a middleware hook.
This hook runs before the model call and asks the user to name the agent
the first time. The middleware also declares the agent_name state field
that stores the answer.
from typing import Any, NotRequired
from copilotkit import CopilotKitMiddleware, CopilotKitState
from deepagents import create_deep_agent
from langchain_openai import ChatOpenAI
from langchain.agents.middleware import AgentMiddleware
from langgraph.runtime import Runtime
from langgraph.types import interrupt
class AgentState(CopilotKitState):
agent_name: NotRequired[str]
class AgentNameMiddleware(AgentMiddleware[AgentState, Any]):
state_schema = AgentState
def before_model(self, state: AgentState, runtime: Runtime[Any]) -> dict[str, Any] | None:
if not state.get("agent_name"):
# Interrupt and wait for the user to respond with a name
name = interrupt("Before we start, what would you like to call me?")
return {"agent_name": name}
return None
agent = create_deep_agent(
model=ChatOpenAI(model="gpt-6-luna", reasoning_effort="none"),
middleware=[
AgentNameMiddleware(),
CopilotKitMiddleware(expose_state=["agent_name"]),
],
system_prompt=(
"You are a helpful assistant. After the user chooses a name, "
"Current agent state contains agent_name. Use that value as your own name."
),
)Make the agent aware of the answer
Resuming an interrupt and telling the model about the answer are separate steps. By default the model is not aware of the interaction: the run resumes, and the model never sees what the user chose.
The custom middleware saves the answer in thread state. In TypeScript,
zodState also keeps the custom field in the graph's output, so AG-UI can
send it to the frontend. The CopilotKit middleware then adds only the
allowlisted field (expose_state / exposeState) to each model request,
and the system prompt says what that field means. State exposure is off by
default, so without the allowlist the model never sees the name. Keep the
allowlist narrow, and do not expose unrelated application state.
Handle the interrupt in your frontend
Give useInterrupt a component to render, and call resolve with the
user's answer. Whatever you pass to resolve becomes the return value of
interrupt().
import { useInterrupt } from "@copilotkit/react-core/v2";
// ...
const YourMainContent = () => {
// ...
// styles omitted for brevity
useInterrupt({
render: ({ event, resolve }) => (
<div>
<p>{event.value}</p>
<form onSubmit={(e) => {
e.preventDefault();
resolve((e.target as HTMLFormElement).response.value);
}}>
<input type="text" name="response" placeholder="Enter your response" />
<button type="submit">Submit</button>
</form>
</div>
)
});
// ...
return <div>{/* ... */}</div>
}The AG-UI LangGraph adapter sends an object interrupt value as a JSON
string, so parse event.value before you read fields from it.
When your app already selects an agent in its CopilotKit provider,
useInterrupt uses that agent. Pass agentId only when this component
must target a different agent in a multi-agent app.
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 the agent emits, for example interrupt() in a LangGraph node |
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.
Pattern 1: useHumanInTheLoop (tool-based)
The app registers a HITL tool on the client with useHumanInTheLoop. When the LLM calls that tool, CopilotKit renders your Vue component and gives it a respond callback during the executing phase. The agent sees the answer as the tool result and continues from there.
<script setup lang="ts">
import { z } from "zod";
import { useHumanInTheLoop } from "@copilotkit/vue/v2";
import TimePickerCard from "./TimePickerCard.vue";
useHumanInTheLoop({
name: "schedule_meeting",
description: "Ask the user to select a meeting time.",
parameters: z.object({
topic: z.string(),
attendee: z.string(),
}),
render: TimePickerCard,
});
</script>
<template><p>Meeting approval tool registered.</p></template>TimePickerCard.vue receives the tool arguments and a respond callback. respond is defined only while the tool call is executing:
<script setup lang="ts">
const props = defineProps<{
args: { topic?: string; attendee?: string };
respond?: (result: unknown) => Promise<void>;
}>();
</script>
<template>
<section>
<p>Pick a time for {{ props.args.topic ?? "the meeting" }}</p>
<button
:disabled="!props.respond"
@click="props.respond?.({ chosen_time: '09:00' })"
>
Tomorrow at 09:00
</button>
</section>
</template>The picker UI can use static candidate slots, live availability, a calendar API, or any other application data. Mount the registration component beneath CopilotKitProvider so the composable can reach the runtime.
Pattern 2: useInterrupt (graph-paused)
With a runtime interrupt, your agent code enforces the pause:
- The agent interrupts with a serializable payload.
- The run stops.
- The client renders your UI with the payload.
- The user answers, and the client resumes the run with the answer.
CopilotKit's useInterrupt composable and CopilotChat's #interrupt slot form the Vue render contract.
See the useInterrupt deep dive for the full walkthrough, including the backend contract and Vue slot wiring.
Going headless
Both patterns above can drive custom UI. For runtime interrupts, set renderInChat: false and use the reactive state returned by useInterrupt; for a frontend-tool pause, let the Promise-returning HITL tool drive application state. See the headless interrupts guide for the interrupt path.
How is this guide?