# HITL Overview

> Let your agent and your React Native users work through tasks together.

## What is this? [#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.

<video
  src="https://cdn.copilotkit.ai/docs/copilotkit/images/coagents/human-in-the-loop-example.mp4"
  className="rounded-lg shadow-xl"
  loop
  playsInline
  controls
  autoPlay
  muted
/>

## When should I use this? [#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 [#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.

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.

<Steps>
  <Step>
    ### 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.

    <Tabs groupId="agent_language" items={['Python', 'TypeScript']} persist>
      <Tab value="Python">
        ```python title="agent.py"
        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."
            ),
        )
        ```
      </Tab>
      <Tab value="TypeScript">
        ```ts title="agent.ts"
        import {
          createCopilotkitMiddleware,
          zodState,
        } from "@copilotkit/sdk-js/langgraph";
        import { createMiddleware } from "langchain";
        import { createDeepAgent } from "deepagents";
        import { interrupt } from "@langchain/langgraph";
        import { z } from "zod";

        const agentNameMiddleware = createMiddleware({
          name: "AgentState",
          stateSchema: z.object({
            // zodState keeps this custom field in AG-UI state snapshots.
            agentName: zodState(z.string().optional()),
          }),
          beforeModel: (state) => {
            if (!state.agentName) {
              // Interrupt and wait for the user to respond with a name
              const name: string = interrupt("Before we start, what would you like to call me?");
              return { agentName: name };
            }
          },
        });

        const stateAwareCopilotKitMiddleware = createCopilotkitMiddleware({
          exposeState: ["agentName"],
        });

        export const agent = createDeepAgent({
          model: "openai:gpt-6-luna",
          middleware: [
            agentNameMiddleware,
            stateAwareCopilotKitMiddleware,
          ],
          systemPrompt:
            "You are a helpful assistant. After the user chooses a name, " +
            "Current agent state contains agentName. Use that value as your own name.",
        });
        ```
      </Tab>
    </Tabs>

  </Step>
  <Step>
    ### 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.

  </Step>
  <Step>
    ### 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()`.

    ```tsx title="app/page.tsx"
    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.

  </Step>
</Steps>

## Pattern 1: `useHumanInTheLoop` (tool-based) [#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.

```tsx title="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({ // [!code highlight:7]
    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 [#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](/react-native/deepagents/custom-look-and-feel/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) [#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](/react-native/deepagents/human-in-the-loop/useInterrupt) for the full walkthrough, including the backend and the render callback.

## Going headless [#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](/react-native/deepagents/human-in-the-loop/headless).

<IntegrationGrid path="human-in-the-loop" />
