# State Streaming

> Stream partial agent state updates to the UI while a tool call is still running.

## What is this? [#what-is-this]

By default, agent state only updates *between* backend checkpoints, so a long-running tool call, such as writing a full document or drafting an email, appears to the UI as one big burst at the end. For agent-native apps, that feels broken: users expect to watch the output materialize.

**State streaming** copies the value of one tool argument into an agent state key while the model writes it. The UI, subscribed through `useAgent`, re-renders every token.

## When should I use this? [#when-should-i-use-this]

Use state streaming whenever a tool's output is long-form text or a growing structured value and you want the user to see it assemble in real time. Common shapes:

- A collaborative writing agent that emits a document
- A research agent that accumulates a list of findings
- A planning agent that builds up a step-by-step plan

Without streaming, the user stares at a spinner. With streaming, they see the answer grow token-by-token.

## The backend: one streaming state mapping [#the-backend-one-streaming-state-mapping]

<Steps>
  <Step>
    ### Map the tool argument with `predict_state_config`

    `predict_state_config` names the tool and the argument to stream into a
    state key. While the model generates the `write_document` call, the
    adapter sends each partial `document` argument to the UI as a state
    update. Returning `state_update(...)` from the tool commits the final
    value when the call completes:

    ```python title="src/agents/shared_state_streaming.py"
    from typing import Annotated

    from agent_framework import tool
    from agent_framework_ag_ui import state_update
    from pydantic import Field

    # Stream tool-argument deltas straight into `state.document` while
    # `write_document` is still streaming.
    PREDICT_STATE_CONFIG: dict[str, dict[str, str]] = {
        "document": {
            "tool": "write_document",
            "tool_argument": "document",
        }
    }


    @tool(
        name="write_document",
        description=(
            "Write a document for the user. Always call this tool when the "
            "user asks you to write, draft, or revise any text. The "
            "`document` argument is streamed per-token into shared state "
            "under the `document` key so the UI renders the body live."
        ),
    )
    def write_document(
        document: Annotated[
            str,
            Field(description="The full document content as a single string."),
        ],
    ):
        return state_update(
            text="Document written to shared state.",
            state={"document": document},
        )
    ```

  </Step>
  <Step>
    ### Seed the state key before the deltas arrive

    The streamed updates are JSON Patch `replace` operations on
    `/document`. The agent's initial state is `{}`, and a `state_schema`
    defines properties but sets no starting values, so on the first turn the
    path does not exist yet. The
    frontend rejects the patch ("Failed to apply state patch") and the run
    never settles.

    Emit a `STATE_SNAPSHOT` that carries the key right after `RUN_STARTED`,
    keeping any value from an earlier turn:

    ```python title="src/agents/shared_state_streaming.py"
    from collections.abc import AsyncGenerator
    from typing import Any

    from ag_ui.core import BaseEvent, EventType, StateSnapshotEvent
    from agent_framework import Agent, BaseChatClient
    from agent_framework_ag_ui import AgentFrameworkAgent


    class SharedStateStreamingFrameworkAgent(AgentFrameworkAgent):
        async def run(  # type: ignore[override]
            self,
            input_data: dict[str, Any],
        ) -> AsyncGenerator[BaseEvent, None]:
            incoming = input_data.get("state")
            state = incoming if isinstance(incoming, dict) else {}
            document = state.get("document", "")
            seeded = False
            async for event in super().run(input_data):
                yield event
                # RUN_STARTED must be the first event; the seed follows it.
                if not seeded and getattr(event, "type", None) == EventType.RUN_STARTED:
                    yield StateSnapshotEvent(
                        type=EventType.STATE_SNAPSHOT,
                        snapshot={**state, "document": document},
                    )
                    seeded = True


    def create_shared_state_streaming_agent(
        chat_client: BaseChatClient,
    ) -> AgentFrameworkAgent:
        base_agent = Agent(
            client=chat_client,
            name="shared_state_streaming_agent",
            instructions=SYSTEM_PROMPT,  # tells the model to call write_document
            tools=[write_document],
        )

        return SharedStateStreamingFrameworkAgent(
            agent=base_agent,
            name="SharedStateStreamingAgent",
            description=(
                "Per-token state streaming: `write_document` arg deltas land "
                "in `state.document` as the tool call is generated."
            ),
            predict_state_config=PREDICT_STATE_CONFIG,
            require_confirmation=False,
        )
    ```

  </Step>
</Steps>

The backend pattern is always the same: map one streaming tool argument to one shared-state key. Middleware-backed frameworks usually expose this as a declarative mapping. Direct SDK adapters do the same work in their streaming loop by parsing partial tool arguments and emitting `STATE_SNAPSHOT` whenever the mapped value changes. When the LLM streams that argument, CopilotKit writes every partial value into shared state before the tool finishes executing. The sample below is the LangGraph (Python) version.

```python title="src/agents/shared_state_streaming.py"
# Tells the runtime to stream tool-argument deltas straight into
# `state.document` while `write_document` is still streaming — matches
# LGP's StateStreamingMiddleware setup.
PREDICT_STATE_CONFIG: dict[str, dict[str, str]] = {
    "document": {
        "tool": "write_document",
        "tool_argument": "document",
    }
}
```

A few things to note:

- The state key must exist in your agent state (`document` in this example).
- The tool and argument names must match the exact LLM-facing tool call you want to forward.
- When the tool call completes, its final return value is written to the same key, so the streamed partial eventually becomes the authoritative final value.

## The frontend: useAgent + OnStateChanged [#the-frontend-useagent--onstatechanged]

The UI side is identical to any other [shared-state](/vue/shared-state) subscription: `useAgent` with `OnStateChanged` gives you a reactive `agent.value.state`. Add `OnRunStatusChanged` if you want a live/done indicator.

```vue title="src/components/StreamingDocument.vue"
<script setup lang="ts">
import { computed } from "vue";
import { useAgent, UseAgentUpdate } from "@copilotkit/vue/v2";

type DocumentState = { document?: string };

const { agent } = useAgent({
  agentId: "writer",
  updates: [
    UseAgentUpdate.OnStateChanged,
    UseAgentUpdate.OnRunStatusChanged,
  ],
});
const state = computed(
  () => (agent.value?.state ?? {}) as DocumentState,
);
</script>

<template>
  <article aria-live="polite">
    <span v-if="agent?.isRunning">LIVE</span>
    <p>{{ state.document ?? "Waiting for a draft…" }}</p>
  </article>
</template>
```

From there, `state.document` is a string that grows on every token, and `agent.isRunning` tells you whether to show a streaming indicator.

```vue title="src/App.vue"
<script setup lang="ts">
import { CopilotChat, CopilotKitProvider } from "@copilotkit/vue/v2";
import StreamingDocument from "./components/StreamingDocument.vue";
</script>

<template>
  <CopilotKitProvider runtime-url="/api/copilotkit">
    <StreamingDocument />
    <CopilotChat agent-id="writer" />
  </CopilotKitProvider>
</template>
```

Ask the writer agent to draft a short document. The LIVE badge shows, and the text grows while the agent writes.

If the runtime does not emit partial state snapshots, the UI sees only the final state. The Vue frontend cannot invent updates the backend never sends.

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