Shared State
Create a two-way connection between your UI and agent state.
What is shared state?
Agentic Copilots maintain a shared state that connects your UI with the agent's execution. This shared state lets you:
- Display the agent's current progress and intermediate results
- Update the agent's state through UI interactions
- React to state changes in real-time across your application
See this in Inspector
Open Inspector on localhost. Go to Inspect, then Agent. The Current State section shows the agent state as the run proceeds. With Intelligence on, you can also open a thread in Rich Threads and click State to see its saved state.
More detail: Inspector.
When should I use this?
Use shared state when you want the agent and the user to collaborate through the same application state. The UI shows what the agent writes. The agent reads what the user changes in the UI.
Building stateful agents?Persistent threads ship with CopilotKit Intelligence on the free Developer tier.Get CopilotKit Intelligence freeReading agent state
Declare the shared keys on your Flow state
A Flow keeps its state in self.state. Type the Flow on a subclass of
CopilotKitState and declare every key the UI reads or writes, with a
default. CopilotKitState brings the CopilotKit messages and actions.
from typing import List, Optional
from ag_ui_crewai import CopilotKitState
from pydantic import BaseModel, Field
class Preferences(BaseModel):
name: str = ""
tone: str = "casual"
language: str = "English"
interests: List[str] = Field(default_factory=list)
class AgentState(CopilotKitState):
# Written by the UI with agent.setState
preferences: Optional[Preferences] = None
# Written by the agent, read by the UI with useAgent
notes: List[str] = Field(default_factory=list)Import CopilotKitState from ag_ui_crewai. If you promoted the Flow to a
Conversational Flow, keep inheriting
from ag_ui_crewai.CopilotKitState: it also carries the conversation
fields CrewAI needs.
Read what the UI wrote
Values the UI writes with agent.setState are on self.state when the
next run starts. A nested model can arrive as a plain dict, so convert it
before you use it:
from crewai.flow.flow import Flow, start
class SharedStateReadWriteFlow(Flow[AgentState]):
@start()
async def chat(self) -> None:
prefs = self.state.preferences
if isinstance(prefs, dict):
prefs = Preferences(**prefs)
self.state.preferences = prefsWrite state and emit it
By default the UI receives the Flow's state only when a method finishes.
To update the UI mid-run, assign the value and call
copilotkit_emit_state:
import asyncio
from typing import TypedDict
from crewai.flow.flow import Flow, start
from ag_ui_crewai import CopilotKitState, copilotkit_emit_state
class Searches(TypedDict):
query: str
done: bool
class AgentState(CopilotKitState):
searches: list[Searches] = []
class SearchFlow(Flow[AgentState]):
@start()
async def chat(self):
self.state.searches = [
{"query": "Initial research", "done": False},
{"query": "Retrieving sources", "done": False},
{"query": "Forming an answer", "done": False},
]
await copilotkit_emit_state(self.state)
for search in self.state.searches:
await asyncio.sleep(1)
search["done"] = True
await copilotkit_emit_state(self.state)The showcase's src/agents/shared_state_read_write.py does the same after
the model calls its set_notes tool: it assigns self.state.notes and
emits the state, so the notes card updates before the turn ends.
Subscribe a component to the agent's state with useAgent. Any time the agent
mutates its state, for example via a tool call, the hook fires and your UI
re-renders with the new values.
// Subscribe the component to agent state changes. Any time the agent
// mutates its state (e.g. via its `set_notes` tool) this hook fires,
// we re-render, and the sidebar panels reflect the new values.
const { agent } = useAgent({
agentId: "shared-state-read-write",
updates: [UseAgentUpdate.OnStateChanged],
});The returned agent.state is just a plain object. Read it like any other
piece of React state and render the parts you care about: agent-written
notes, structured outputs, progress indicators, anything the agent has put
there.
Writing agent state
The same agent object exposes a setState setter. Calling it from a UI
event handler pushes the new value into shared state, and the agent reads it
back on its next turn. The UI's writes visibly steer the model.
// WRITE: every edit in the sidebar goes straight into agent state.
// On the agent's next turn, `PreferencesInjectorMiddleware` reads this
// back out of state and adds it to the system prompt — so the UI's
// writes visibly steer the model.
const handlePreferencesChange = (next: Preferences) => {
agent.setState({
preferences: next,
notes, // preserve what the agent has written
} as RWAgentState);
};This makes shared state two-way. The UI can also send the agent new inputs, such as preferences, selections, or partial work. These inputs do not go through the chat.
The agent reads the new state on its next run. To run it right away, call
copilotkit.runAgent({ agent }) (from useCopilotKit) after setState.
Running through copilotkit also sends your frontend tools and context with
the run. To tell the model what changed, add a hint message first:
const { copilotkit } = useCopilotKit();
agent.setState({ language: newLanguage });
agent.addMessage({
id: crypto.randomUUID(),
role: "user",
content: `the language has been updated to ${newLanguage}`,
});
await copilotkit.runAgent({ agent });See Programmatic control for more ways to run the agent from code.
Rendering shared state in the UI
Because agent.state is plain React data, the UI layer is whatever you'd
normally build. The demo on this page wires the agent's outputs into a
small card component and feeds user edits back through setState.
// Read-side render: this card reflects the agent-authored `notes` slice
// of shared state. The parent page passes `state.notes` in; we never
// touch agent state ourselves — we just render it. The Clear button is
// a small write-back, exposed as an `onClear` prop.
export function NotesCard({ notes, onClear }: NotesCardProps) {
return (
<Card data-testid="notes-card" className="w-full">
<CardHeader>
<div className="flex items-start justify-between gap-3">
<div className="space-y-1.5">
<CardTitle>Agent Scratch pad</CardTitle>
<CardDescription>
The agent writes here via its{" "}
<code className="font-mono text-[11px] text-[#010507] dark:text-foreground">
set_notes
</code>{" "}
tool. The UI re-renders from shared state.
</CardDescription>
</div>
{notes.length > 0 && (
<Button
type="button"
onClick={onClear}
data-testid="notes-clear-button"
variant="destructive"
size="sm"
className="uppercase tracking-[0.14em] text-[10px]"
>
Clear
</Button>
)}
</div>
</CardHeader>
<CardContent>
{notes.length === 0 ? (
<div
data-testid="notes-empty"
className="text-sm text-[#838389] italic min-h-[160px] flex items-center justify-center text-center px-4 border border-dashed border-[#E9E9EF] rounded-xl bg-[#FAFAFC] dark:text-muted-foreground dark:border-border dark:bg-muted"
>
the agent will make observations about you and note them here!
</div>
) : (
<ul
data-testid="notes-list"
className="space-y-2 text-sm text-[#010507] dark:text-foreground"
>
{notes.map((note, i) => (
<li
key={i}
data-testid="note-item"
className="flex gap-2 rounded-lg border border-[#E9E9EF] bg-[#FAFAFC] px-3 py-2 dark:border-border dark:bg-muted"
>
<span className="text-[#838389] font-mono text-xs leading-5 select-none dark:text-muted-foreground">
{String(i + 1).padStart(2, "0")}
</span>
<span className="flex-1">{note}</span>
</li>
))}
</ul>
)}
</CardContent>
</Card>
);
}Nothing about this is chat-specific: useAgent works in any component under
<CopilotKit>, so you can render agent.state in your main view or canvas,
not just inside the chat panel. See
Render agent state in your app for the
full main-view pattern.
Streaming partial state updates
By default, agent state only updates between backend checkpoints, so a long-running tool call appears as one big burst at the end. State streaming copies one tool argument into a state key while the model writes it. The UI shows the answer token by token.
class SharedStateStreamingState(CopilotKitState):
document: str = ""
class SharedStateStreamingFlow(Flow[SharedStateStreamingState]):
"""Predict write_document arguments into state, then persist the result."""
@start()
async def write(self) -> None:
await copilotkit_predict_state(
[
StateItem(
state_key="document",
tool="write_document",
tool_argument="document",
)
]
)See State streaming for the full walkthrough,
including the corresponding useAgent subscription on the frontend.
Read-only context
When the value is UI-owned and the agent should read it but never write
it back, such as current user, selected record, or scroll position, reach for
useAgentContext instead of full shared state. It publishes values as a
one-way UI-to-agent channel that auto-unregisters on unmount.
See Agent read-only context for the full pattern.
How is this guide?