# 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 call to a state snapshot

    `AGUIStreamOptions.MapCall` maps a tool call to AG-UI events. Return a
    `StateSnapshotEvent` built from the tool's arguments, and attach the
    options to the endpoint with `WithMetadata`:

    ```csharp title="Program.cs"
    using System.ComponentModel;
    using System.Text.Json;
    using AGUI.Abstractions;
    using AGUI.Server;
    #pragma warning disable OPENAI001
    using Microsoft.Extensions.AI;
    using Microsoft.Agents.AI;
    using Microsoft.Agents.AI.Hosting.AGUI.AspNetCore;
    using Microsoft.Extensions.AI;
    using OpenAI;
    using OpenAI.Chat;

    var builder = WebApplication.CreateBuilder(args);
    builder.Services.AddAGUIServer();
    var app = builder.Build();

    string openAiApiKey = builder.Configuration["OPENAI_API_KEY"]
        ?? throw new InvalidOperationException("Set OPENAI_API_KEY");

    // Define a tool the LLM may call to report its progress
    [Description("Report current step progress.")]
    static string StepProgress([Description("Steps completed so far")] string[] steps)
        => "Progress received.";

    AITool stepProgress = AIFunctionFactory.Create(StepProgress, name: "step_progress");
    var agent = new OpenAIClient(openAiApiKey)
        .GetChatClient("gpt-6-luna")
        .AsIChatClient().AsBuilder()
        .ConfigureOptions(options => options.RawRepresentationFactory = _ =>
            new OpenAI.Chat.ChatCompletionOptions { ReasoningEffortLevel = new("none") })
        .Build()
        .AsAIAgent(
            name: "AGUIAssistant",
            instructions: "You are a helpful assistant that may call the 'step_progress' tool to report intermediate steps.",
            tools: [stepProgress]);

    // Map the completed tool arguments to a shared-state snapshot
    AGUIStreamOptions streamOptions = new AGUIStreamOptions()
        .MapCall("step_progress", call =>
        {
            if (call.Arguments?.TryGetValue("steps", out object? steps) is not true)
            {
                return [];
            }

            JsonElement snapshot = JsonSerializer.SerializeToElement(
                new { observed_steps = steps });
            return [new StateSnapshotEvent { Snapshot = snapshot }];
        });

    app.MapAGUIServer("/", agent).WithMetadata(streamOptions);
    await app.RunAsync();
    ```

  </Step>
  <Step>
    ### Know what streams and what does not

    `MapCall` runs on the completed `FunctionCallContent`, so the state key
    updates once, when the tool call finishes. It does not grow token by
    token while the model writes the arguments. To stream partial arguments
    into state, register a provider-specific extractor with
    `MapStreamingToolCallArguments`.

  </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.

<!-- snippet skipped: region 'state-streaming-middleware' missing in ms-agent-dotnet::shared-state-streaming -->

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"]} />
