Shared State
Create a two-way connection between your UI and agent state.
Not available for Langchain DeepAgents yet
shared-state-read-write demo, and Langchain DeepAgents doesn't have it yet. See this page for CopilotKit's Built-in Agent, LangGraph (Python), LangGraph (TypeScript).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 state on your Deep Agent
A Deep Agent declares its state through middleware. Add your field to a
state schema, and pass that middleware to the agent together with the
CopilotKit middleware. This example shares a language value.
from typing import Any, Literal, NotRequired
from copilotkit import CopilotKitMiddleware, CopilotKitState
from deepagents import create_deep_agent
from langchain_openai import ChatOpenAI
from langchain.agents.middleware import AgentMiddleware
class AgentState(CopilotKitState):
language: NotRequired[Literal["english", "spanish"]]
class LanguageStateMiddleware(AgentMiddleware[AgentState, Any]):
state_schema = AgentState
agent = create_deep_agent(
model=ChatOpenAI(model="gpt-6-luna", reasoning_effort="none"),
middleware=[
LanguageStateMiddleware(),
CopilotKitMiddleware(expose_state=["language"]),
],
system_prompt=(
"You are a helpful assistant. Current agent state contains "
"language. Always answer in that language."
),
)In TypeScript, zodState keeps the field in the AG-UI state snapshots
that reach the frontend.
Expose the field to the model
A value the UI writes with agent.setState reaches the agent's state, but
the CopilotKit middleware does not show state to the model by default.
List the fields the model should see in expose_state (exposeState),
and say in the system prompt what they mean. Without the allowlist, the
run succeeds and the model answers as if the UI had written nothing. Keep
the allowlist narrow.
Read and write the state in your UI
Deep Agents has no live demo on this page yet, so the demo code below does
not show for it. useAgent returns the agent, its reactive state, and
setState:
import { useAgent } from "@copilotkit/react-core/v2";
function YourMainContent() {
const { agent } = useAgent({
agentId: "sample_agent",
});
const language = (agent.state.language as string) ?? "english";
const toggleLanguage = () => {
agent.setState({ language: language === "english" ? "spanish" : "english" });
};
return (
// style excluded for brevity
<div>
<h1>Your main content</h1>
<p>Language: {language}</p>
<button onClick={toggleLanguage}>Toggle Language</button>
</div>
);
}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.
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.
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.
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.
Not available for Langchain DeepAgents yet
shared-state-streaming demo, and Langchain DeepAgents doesn't have it yet.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?