Shared State
Create a two-way connection between your React Native UI and agent state.
What is shared state?
Shared state connects your app's UI with the agent's run. With shared state you can:
- 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 app
When should I use this?
Use shared state when you want the agent and the user to work on the same app 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. Each time the agent changes its state, for example from a tool call, the hook re-renders your component with the new values.
import { Text, View } from "react-native";
import { useAgent, UseAgentUpdate } from "@copilotkit/react-native/headless";
type NotesState = {
notes?: string[];
preferences?: { tone?: string };
};
export function NotesCard() {
const { agent } = useAgent({
agentId: "default",
updates: [UseAgentUpdate.OnStateChanged],
});
const state = (agent.state ?? {}) as NotesState;
return (
<View style={{ padding: 16, gap: 4 }}>
{(state.notes ?? []).map((note) => (
<Text key={note}>• {note}</Text>
))}
</View>
);
}agent.state is a plain object. Read it like any other React data and render the parts you care about: notes the agent wrote, structured output, progress, or anything else the agent put there.
Writing agent state
The same agent has a setState method. Call it from a UI event, and the agent reads the new value on its next turn. The UI's writes steer the model.
import { Button } from "react-native";
// In NotesCard, below the list:
<Button
title="Prefer short answers"
onPress={() =>
agent.setState({
...state,
preferences: { ...state.preferences, tone: "concise" },
})
}
/>This makes shared state two-way. The UI can send the agent new inputs, such as preferences, selections, or partial work, without 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 message first:
const { copilotkit } = useCopilotKit();
agent.setState({ ...state, language: newLanguage });
agent.addMessage({
id: `user-${Date.now()}`,
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. Nothing about it is chat-specific: useAgent works in any component under CopilotKitProvider, so you can render the state on your main screen, not just next to the chat. See Render agent state in your app for the full pattern.
Streaming partial state updates
By default, agent state only updates between backend checkpoints, so a long tool call shows up as one burst at the end. State streaming copies one tool argument into a state key while the model writes it, so 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 useAgent subscription on the frontend.
Read-only context
When a value is UI-owned, and the agent should read it but never write it back, use useAgentContext instead of shared state. Examples are the current user, the selected record, or the open screen. It sends values one way, from the UI to the agent, and removes them when the component unmounts.
See Agent Read-Only Context for the full pattern.
How is this guide?