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
Show the model the state in its instructions
The page's state arrives with every run as RunAgentInput.state, and the
adapter makes it the run's shared state. It does not reach the prompt by
itself. Give the agent dynamic instructions that read it with the
adapter's shared_state(), so the model sees the current value on every
turn, including edits the user made with agent.setState:
def with_state(prompt: str) -> Callable[[RunContextWrapper[Any], Agent[Any]], str]:
"""Dynamic instructions: ``prompt`` plus the run's shared state as JSON."""
def instructions(_ctx: RunContextWrapper[Any], _agent: Agent[Any]) -> str:
state = shared_state().value
if not state:
return prompt
return (
f"{prompt}\n\nCurrent shared application state (JSON; the user may "
f"have edited it since your last turn):\n{json.dumps(state)}"
)
return instructions
READ_WRITE_PROMPT = (
"You are a helpful, concise assistant. The shared application state below "
"has a `preferences` object with the user's name, preferred tone, "
"language and interests, which the user edits in the app: always respect "
"them, and address the user by name when you know it. Its `notes` list "
"holds what you have remembered so far. When the user asks you to "
"remember something, or when you observe something worth surfacing in "
"the UI, call `set_notes` with the FULL updated list of short note "
"strings (existing notes + new)."
)
shared_state_read_write_agent = Agent(
name="preferences_assistant",
instructions=with_state(READ_WRITE_PROMPT),
model=MODEL,
model_settings=chat_settings(),
tools=[set_notes],
)
Write state from a server tool
Server tools are ordinary @function_tool functions. Inside one,
shared_state().update(...) merges top-level keys into the state and
streams a STATE_SNAPSHOT to the browser before the tool's own result, so
any component subscribed with useAgent re-renders while the agent is
still running.
@function_tool
def set_notes(notes: list[str]) -> str:
"""Replace the notes array in shared state with the full updated list.
Use this tool whenever the user asks you to "remember" something, or
when you have an observation about the user worth surfacing in the
UI's notes panel. Always pass the FULL notes list (existing notes +
any new ones), not a diff. Keep each note short (< 120 chars).
"""
shared_state().update(notes=notes)
return "Notes updated."
shared_state().set(value) replaces the whole state instead. The
request's own state is never changed.
Inside an OpenAIAgentsAgent run
OpenAIAgentsAgent sets up shared_state() for every request. If you
drive the SDK yourself with the adapter's translator, start the run inside
use_shared_state(SharedState(run_input.state)) and pass the same object
to to_agui.
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, its dynamic instructions show the model this
// state — 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.
def _document_so_far(arguments: str) -> str | None:
"""The ``document`` argument as far as the model has written it."""
try:
# Unfinished JSON: a string cut off mid-way is kept as it stands.
value = from_json(arguments, allow_partial="trailing-strings")
except ValueError:
return None
document = value.get("document") if isinstance(value, dict) else None
return document if isinstance(document, str) else None
class DocumentStreamingAgent(OpenAIAgentsAgent):
"""Streams ``write_document``'s ``document`` argument into the state."""
async def run_streamed(self, input: RunAgentInput) -> AsyncIterator[BaseEvent]:
arguments: dict[str, str] = {} # tool call id -> arguments so far
async with aclosing(super().run_streamed(input)) as events:
async for event in events:
yield event
if (
event.type == EventType.TOOL_CALL_START
and event.tool_call_name == write_document.name
):
arguments[event.tool_call_id] = ""
elif (
event.type == EventType.TOOL_CALL_ARGS
and event.tool_call_id in arguments
):
arguments[event.tool_call_id] += event.delta
document = _document_so_far(arguments[event.tool_call_id])
if document is not None:
yield StateDeltaEvent(
type=EventType.STATE_DELTA,
delta=[
{"op": "add", "path": "/document", "value": 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?