Pausing the Agent for Input

Pause an agent run mid-tool, hand control to a custom React component, and resume with the user's answer.

Not available for Langchain DeepAgents yet

The code on this page comes from the showcase's gen-ui-interrupt demo, and Langchain DeepAgents doesn't have it yet. See this page for CopilotKit's Built-in Agent, LangGraph (Python), LangGraph (TypeScript).

What is this?

Some agent steps need a person's answer before the run can continue, such as approving a payment or picking a meeting time. useInterrupt pauses the run, shows your React component, and resumes the run with the answer. How the pause works depends on your agent framework.

This framework ships a first-class interrupt primitive that lets running work suspend itself and hand control to the client: interrupt() in LangGraph, interrupts in AWS Strands, a tool that returns suspend() in Mastra, or a @human_feedback step in a CrewAI Flow. The run is frozen server-side until the client resolves the interrupt with a payload. Then the run resumes, and the agent receives that payload as the answer.

CopilotKit's useInterrupt is the frontend half of that contract: it subscribes to the paused run, renders whatever component you give it, and calls the agent back with the user's answer.

When should I use this?

Reach for useInterrupt when the pause is a checkpoint in your agent code where the code path must stop and wait for a human, not an LLM-initiated tool call. Typical cases:

  • A sensitive action (payments, irreversible writes) must be approved
  • A required piece of state isn't known and can only be collected from the user
  • The agent explicitly reaches an approval node in a longer workflow
  • You want the server-side contract to be an interrupt that resumes with a payload

For LLM-initiated pauses where the model decides on the fly to ask the user, prefer useHumanInTheLoop.

The backend: pause the run in your agent

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.

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."
    ),
)

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().

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.

In the tool or step that needs the user's answer, call your framework's interrupt primitive with the data your UI needs: interrupt() in LangGraph, suspend() in Mastra, or a @human_feedback step in a CrewAI Flow. The example agent does this in its schedule_meeting tool:

The run stops here until the client resolves the interrupt. The resolve payload comes back to the agent as the answer: the return value of interrupt() in LangGraph, resumeData in Mastra, or the HumanFeedbackResult that the next step of a CrewAI Flow receives. The example turns that value into a string for the model.

Two things to note:

  • The payload ({"topic": topic, "attendee": attendee}) is what the frontend reads off the interrupt. Keep it a plain, serializable object. It's the "pause-time context" the UI needs to render.
  • The return-side contract ({chosen_label, chosen_time} or {cancelled: true}) is entirely yours. The client can send anything as the resolve payload; the tool is the one that gives it meaning.

The frontend: useInterrupt render prop

On the client you register a useInterrupt hook per agent. When the paused run arrives, render receives both the raw event and the interrupt itself, and resolve(...) is how you resume the run. Your agent framework decides where the payload sits:

  • Custom-event interrupt (on_interrupt): event.value.
  • Standard AG-UI interrupt: interrupt.metadata, or a JSON string in interrupt.message.

Whatever you pass to resolve is sent back to the agent as the answer to the matching interrupt, for example the return value of interrupt(...) in LangGraph.

Ask the agent to book a call. The time picker appears in the chat. Pick a slot, and the agent confirms the booked time.

Key props

  • agentId: must match a runtime-registered agent. If omitted, the hook uses the agent of the surrounding chat configuration, then the agentId set on CopilotKitProvider, then "default". A mismatch means the interrupt never fires.
  • render: receives { event, interrupt, resolve }.
  • renderInChat: when true (as above), the picker appears inline in the chat transcript, between the paused assistant turn and the still-pending continuation. To show it outside the chat, see Headless interrupts.

Multiple interrupts? Add a type and gate with enabled

If your agent issues more than one kind of interrupt (e.g. "ask" vs "approval"), tag each with a type field on the payload and install one useInterrupt per shape, each gated by an enabled predicate:

// The LangGraph adapter sends `event.value` as a JSON string.
const readValue = (value: unknown) =>
  typeof value === "string" ? JSON.parse(value) : value;

useInterrupt({
  agentId: "gen-ui-interrupt",
  enabled: (event) => readValue(event.value).type === "ask",
  render: ({ event, resolve }) => (
    <AskCard question={readValue(event.value).content} onAnswer={resolve} />
  ),
});

useInterrupt({
  agentId: "gen-ui-interrupt",
  enabled: (event) => readValue(event.value).type === "approval",
  render: ({ event, resolve }) => (
    <ApproveCard content={readValue(event.value).content} onAnswer={resolve} />
  ),
});

Preprocess with handler

For cases where the interrupt can sometimes be resolved without user input (e.g. the current user already has permission), pass a handler that runs before render. The handler can call resolve(...) itself to resume the agent early. The interrupt card unmounts when the resume run starts. Or return a value that render receives as result:

useInterrupt({
  agentId: "gen-ui-interrupt",
  handler: async ({ event, resolve }) => {
    const value =
      typeof event.value === "string" ? JSON.parse(event.value) : event.value;
    const dept = await lookupUserDepartment();
    if (value.accessDepartment === dept || dept === "admin") {
      resolve({ code: "AUTH_BY_DEPARTMENT" });
      return; // agent will resume; card unmounts when the run starts
    }
    return { dept };
  },
  render: ({ result, event, resolve }) => (
    <RequestAccessCard
      dept={result?.dept}
      onRequest={() => resolve({ code: "REQUEST_AUTH" })}
      onCancel={() => resolve({ code: "CANCEL" })}
    />
  ),
});

AG-UI standard interrupt flow vs. custom-event flow

This section is a reference for developers who write render code for their own agent. The useInterrupt reference lists every option. useInterrupt handles two kinds of interrupt, and your agent framework decides which kind it sends.

Standard flow (RUN_FINISHED with outcome.type === "interrupt")

When the agent backend conforms to the AG-UI protocol, it signals an interrupt by emitting a RUN_FINISHED event whose outcome carries the interrupts array:

outcome.type === "interrupt"
outcome.interrupts  // Interrupt[]

The hook detects this on onRunFinishedEvent and exposes the interrupts on the render props after onRunFinalized fires. Your render function receives:

  • interrupt: the primary Interrupt (interrupts[0]), with shape { id, reason, message?, toolCallId?, responseSchema?, expiresAt?, metadata? }.
  • interrupts: the full open set (usually one, but multi-interrupt is supported, as described below).
  • resolve(payload?, interruptId?): records { status: "resolved", payload } for the targeted interrupt (defaults to the primary). The agent run resumes once every open interrupt has a response.
  • cancel(interruptId?): records { status: "cancelled" } for the targeted interrupt. Same accumulate-then-submit logic applies.

Each resume entry carries the interrupt id, the status, and your payload. resolve and cancel send no metadata.

Custom-event flow (on_interrupt)

Agents that emit a custom on_interrupt event use this flow. The LangGraph adapter emits this event by default. The hook detects this on onCustomEvent and sets interrupt to null and interrupts to []. The payload is in event.value. Calling resolve(payload) resumes via forwardedProps.command (the custom-event resume mechanism). cancel() dismisses the interrupt without resuming. The agent never receives a response.

Priority

If both signals appear on the same run, the standard flow wins.

Approve / Cancel example

function ApprovalInterrupt() {
  useInterrupt({
    render: ({ interrupt, resolve, cancel }) => (
      <div className="p-3 border rounded">
        <p>{interrupt?.message ?? "Approve this action?"}</p>
        <div className="mt-2 flex gap-2">
          <button onClick={() => resolve({ approved: true })}>Approve</button>
          <button onClick={() => cancel()}>Cancel</button>
        </div>
      </div>
    ),
  });
  return null;
}

resolve({ approved: true }) records a resolved entry and submits the resume array to the agent. cancel() records a cancelled entry and does the same. Both return the RunAgentResult once the run restarts.

Multi-interrupt behavior

Some agents issue more than one interrupt in a single run (e.g. two independent approvals). Each interrupt has its own id. Address them individually:

useInterrupt({
  render: ({ interrupts, resolve, cancel }) => (
    <ul>
      {interrupts.map((i) => (
        <li key={i.id}>
          {i.message}
          <button onClick={() => resolve({ ok: true }, i.id)}>Approve</button>
          <button onClick={() => cancel(i.id)}>Cancel</button>
        </li>
      ))}
    </ul>
  ),
});

The agent run only resumes once every open interrupt has been addressed. Calling resolve or cancel with a specific interruptId marks that interrupt done; the hook auto-submits the accumulated responses when the last one is addressed. If you omit interruptId, the primary interrupt (interrupts[0]) is targeted.

responseSchema: surface only, no client-side validation

The Interrupt type exposes a responseSchema field (a JSON Schema object) that the agent can use to describe the expected payload shape. useInterrupt surfaces this field on interrupt.responseSchema for your UI to read (e.g. to drive a form), but it does not validate resolve payloads against it. Validation is the agent's responsibility on resume.

How is this guide?