# Shared State

> Create a two-way connection between your UI and agent state.

> **Not available for agent-spec yet.** The code on this page comes from the showcase's `shared-state-read-write` demo, and agent-spec doesn't have it yet. See this page for [CopilotKit's Built-in Agent](/shared-state), [LangGraph (Python)](/langgraph-python/shared-state), [LangGraph (TypeScript)](/langgraph-typescript/shared-state).

## What is shared 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

<ImageZoom
  src="https://cdn.copilotkit.ai/docs/copilotkit/images/coagents/SharedStateCoAgents.gif"
  alt="Shared State Demo"
  width={1000}
  height={1000}
  className="rounded-lg shadow-lg border mt-0"
/>

<Callout type="info" title="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](/agent-spec/inspector).
</Callout>

## When should I use this? [#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.

<OpsPlatformCTA
  variant="inline"
  title="Building stateful agents?"
  body="Persistent threads ship with CopilotKit Intelligence on the free Developer tier."
  surface="docs_shared_state"
/>

## Reading agent state [#reading-agent-state]

<Callout type="warn" title="Shared state on Agent Spec">
  Agent Spec agentic chat streams text and tool events. It has no shared-state
  sync, so the `useAgent` state patterns on this page are not available for
  Agent Spec. For shared-state patterns, mirror what you surface as messages
  or tool calls. See the
  [Agent Spec reference sheet](https://oracle.github.io/agent-spec/development/misc/reference_sheet.html)
  for the event formats.
</Callout>

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 [#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:

```tsx
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](/agent-spec/programmatic-control) for more ways to run the
agent from code.

## Rendering shared state in the UI [#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](/agent-spec/shared-state/rendering-in-app)** for the
full main-view pattern.

## Streaming partial state updates [#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.

<WhenFrameworkSupports feature="shared-state-streaming">

> **Not available for agent-spec yet.** This sample comes from the showcase's `shared-state-streaming` demo, and agent-spec doesn't have it yet.

See **[State streaming](/agent-spec/shared-state/streaming)** for the full walkthrough,
including the corresponding `useAgent` subscription on the frontend.

</WhenFrameworkSupports>

<WhenFrameworkSupports feature="shared-state-streaming" not>

State streaming isn't available on this framework yet. The UI gets the
agent's state between checkpoints.

</WhenFrameworkSupports>

## Read-only context [#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](/agent-spec/shared-state/agent-readonly)** for the
full pattern.

<IntegrationGrid path="shared-state" exclude={["agno", "agent-spec", "spring-ai", "langroid"]} />
