Interactive components
Create approval flows where the agent pauses and waits for human input.
What is this?
Interactive generative UI creates flows where the agent pauses execution and waits for user input before continuing. This enables approval workflows, confirmation dialogs, and any scenario where human judgment is needed mid-execution.
When should I use this?
Use interactive generative UI when you need:
- Approval/rejection flows (e.g. "Run this command?")
- User decisions that the agent should know about
- Confirmation dialogs with structured responses
- Any flow where the agent pauses for human judgment
How it works in code
Nothing to wire for useHumanInTheLoop
A tool registered with useHumanInTheLoop is a frontend tool. The AG-UI
hosting layer merges the request's tool definitions into the tool list the
model sees, so the agent declares nothing for it. The harness takes its
tool list through ChatOptions, and leaving Tools empty is correct when
the only tools in play are frontend ones:
return chatClient.AsHarnessAgent(
HarnessMaxContextWindowTokens,
HarnessMaxOutputTokens,
new HarnessAgentOptions
{
Name = "AGUIAssistant",
ChatOptions = new ChatOptions
{
Instructions = SystemPrompt,
MaxOutputTokens = HarnessMaxOutputTokens,
Tools = [],
},
});This framework registers schedule_meeting as a frontend tool with
useHumanInTheLoop. The agent calls the tool, and the chat renders the picker.
The tool call resolves when the picker calls respond(...), after the user
chooses a slot or cancels.
import {
CopilotKit,
CopilotChat,
useHumanInTheLoop,
} from "@copilotkit/react-core/v2";
import { z } from "zod";
import type { TimeSlot } from "./_components/time-picker-card";
import { TimePickerCard } from "./_components/time-picker-card";
import { generateFallbackSlots } from "../_shared/interrupt-fallback-slots";
import { useGenUiInterruptSuggestions } from "./suggestions";
export default function GenUiInterruptDemo() {
return (
<CopilotKit runtimeUrl="/api/copilotkit" agent="gen-ui-interrupt">
<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() {
useGenUiInterruptSuggestions();
// MS Agent Framework has no `interrupt()` primitive, so the LangGraph
// showcase's `useInterrupt({ renderInChat: true })` hook is silently dead
// here — it listens for AG-UI `interrupt` events that the MAF backend
// never emits, leaving the chat stuck on the "[Scheduling...]" tool-call
// placeholder.
//
// `interrupt_agent.py` instead exposes `schedule_meeting` as a tool the
// model is instructed to call; the frontend registers a matching
// `useHumanInTheLoop` here, renders the picker inline, and resolves the
// call via `respond(...)`. UX matches LGP's interrupt-rendered card; the
// mechanism differs.
useHumanInTheLoop({
agentId: "gen-ui-interrupt",
name: "schedule_meeting",
description:
"Ask the user to pick a meeting time. The picker renders inline in " +
"the chat; the chosen slot is returned to the agent so it can confirm.",
parameters: z.object({
topic: z
.string()
.describe("What the meeting is about (e.g. 'Intro with sales')"),
attendee: z
.string()
.optional()
.describe("Who the meeting is with (e.g. 'Alice')"),
}),
render: ({ args, respond }: any) => {
// `TimePickerCard` here is the gen-ui-interrupt-specific variant
// (under `_components/`) that gates buttons on its own internal
// `picked`/`cancelled` state — it doesn't take a `status` prop like
// the hitl-in-chat version. That's fine: the buttons stay clickable
// until the user makes a choice and `respond(...)` resolves the
// tool call.
const topic = (args?.topic as string | undefined) ?? "a call";
const attendee = args?.attendee as string | undefined;
const slots = generateFallbackSlots();
return (
<TimePickerCard
topic={topic}
attendee={attendee}
slots={slots}
onSubmit={(result) => respond?.(result)}
/>
);
},
}); public AIAgent CreateInterruptAgent()
{
var chatClient = _openAiClient.GetChatClient("gpt-6-luna").AsLunaChatClient();
// No backend fallback tool is registered. If the frontend tool is
// missing, the demo should fail visibly instead of bypassing the
// picker with a server-side response.
var harnessAgent = chatClient.AsHarnessAgent(
HarnessMaxContextWindowTokens,
HarnessMaxOutputTokens,
new HarnessAgentOptions
{
Name = "InterruptAgent",
Description = "Interrupt scheduling assistant (NOT-SUPPORTED) powered by Microsoft Agent Harness over Microsoft Agent Framework.",
ChatOptions = new ChatOptions
{
Instructions = SystemPrompt,
MaxOutputTokens = HarnessMaxOutputTokens,
Tools = [],
},
});
return new SharedStateAgent(harnessAgent, _jsonSerializerOptions, _loggerFactory.CreateLogger<SharedStateAgent>());
}Ask the agent to book a call, for example Book an intro call with the sales team to discuss pricing. The time picker appears in the chat. Pick a slot,
and the agent confirms the booked time.
How is this guide?