Render the agent’s live state
Some work does not fit into a single tool call. A research task, a multi-step plan, a long-running job: the interesting thing to show the user is not one result, but progress. Agentic generative UI renders the agent’s state and re-renders it every time that state changes. The pattern has two halves:- Your Flow writes progress into its own state as it works.
- Your frontend reads that state with
useAgentand paints it, re-rendering as the state streams in.
copilotkit_emit_state explicitly. You subclass the state to add your own fields, update them in the Flow, and read them in React.
State-driven rendering requires a Flow with custom state (
Flow[AgentState]). Crews are chat-oriented and do not expose custom state this way, so with a Crew use tool rendering instead.Build a live task planner
This example builds a planner that breaks a request into about ten steps and streams them to the UI as a checklist. It assumes you already have a CrewAI server and a CopilotKit frontend wired up. If you do not, start with the Frontend Overview.1
Add your own fields to the agent state
Subclass Everything on
CopilotKitState to declare the state your UI needs. CopilotKitState already carries the conversation (messages); you add whatever else you want to render, here a list of task steps.AgentState is included in the state snapshot the frontend receives. A snapshot is emitted automatically at each step boundary, so writing to self.state is enough for the UI to pick it up between steps. To update the UI during a long step, emit explicitly (shown below).2
Write progress into state from the Flow
Type your Flow with the custom state (Wrapping the LLM call in
Flow[AgentState]) and let the model fill it in. Here the LLM calls a generate_task_steps tool; the streamed tool call lands in the conversation and the steps become visible in state.copilotkit_stream streams the assistant’s tokens and tool call to the frontend as they are produced. The steps you write to self.state are sent in the state snapshot emitted at the end of this step.3
Stream progress during a long step (optional)
The automatic snapshot fires at step boundaries. If a single step does substantial work and you want the checklist to fill in as it happens, emit intermediate state yourself with Import
copilotkit_emit_state. Each call pushes the current state to the frontend immediately.copilotkit_emit_state from ag_ui_crewai.sdk. It requires the CopilotKit SDK (pip install "copilotkit[crewai]"). Reach for it only when a step is long enough that waiting for its boundary snapshot would feel unresponsive.4
Serve the Flow over AG-UI
Register the Flow exactly as any other, on its own path:See the Frontend Overview for the full server, runtime, and provider setup, and remember to register the agent (here
task_planner) in your CopilotKit runtime route.5
Read the live state in React
On the frontend,
useAgent gives you the agent’s live state. Subscribe to state changes so your component re-renders every time the Flow writes an update.useAgent returns { agent }. A few things to know:agent.stateis the live Flow state. Its shape matches the fields you added toAgentState, soagent.state.stepsis your list of task steps.agent.isRunningtells you when the agent is actively working, useful for showing a spinner or disabling input.updates: [UseAgentUpdate.OnStateChanged]re-renders the component whenever state changes, so the checklist fills in as the Flow streams its steps.
Where this goes next
Reading state is the foundation. Two guides build directly on it:- Shared State adds the other direction: editing the agent’s state from the UI and having the Flow pick up the change.
- Predictive State streams a tool’s in-progress arguments into state so the UI reflects work before it is committed.
Related
Shared State
Sync agent state and app UI in both directions.
Predictive State
Stream in-progress tool arguments into state.
Tool-Based Generative UI
Map agent tool calls to components.
