# State Streaming

> Stream partial agent state to your React Native 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 tool call (writing a full document, drafting an email) reaches the UI as one burst at the end. In an agent-native app, that feels broken: users expect to watch the output appear.

**State streaming** copies one tool argument into an agent state key while the model writes the argument. Your screen, subscribed with `useAgent`, re-renders on every token.

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

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

- A writing agent that produces a document
- A research agent that collects a list of findings
- A planning agent that builds a step-by-step plan

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

<Callout type="info">
  **Not available on this framework yet.** This framework's showcase doesn't support state streaming. The UI gets the agent's state between checkpoints, which the [Shared State](/react-native/crewai-crews/shared-state) page covers.
</Callout>

</WhenFrameworkSupports>

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

<Steps>
  <Step>
    ### Install the CrewAI AG-UI package

    ```bash
    pip install ag-ui-crewai litellm
    ```

  </Step>
  <Step>
    ### Declare the state key

    ```python title="src/agents/shared_state_streaming.py"
    from ag_ui_crewai import CopilotKitState


    class SharedStateStreamingState(CopilotKitState):
        document: str = ""
    ```

  </Step>
  <Step>
    ### Map the tool argument to the state key

    Call `copilotkit_predict_state` with one `StateItem` before the model
    call. While the model streams `write_document`, CopilotKit copies the
    partial `document` argument into the `document` state key. Wrap the call
    in `copilotkit_stream`, or nothing streams until the turn ends.

    ```python title="src/agents/shared_state_streaming.py"
    from crewai.flow.flow import Flow, start
    from litellm import acompletion

    from ag_ui_crewai import StateItem, copilotkit_predict_state, copilotkit_stream


    class SharedStateStreamingFlow(Flow[SharedStateStreamingState]):
        @start()
        async def write(self) -> None:
            await copilotkit_predict_state(
                [
                    StateItem(
                        state_key="document",
                        tool="write_document",
                        tool_argument="document",
                    )
                ]
            )
            tools = [*self.state.copilotkit.actions, WRITE_DOCUMENT_TOOL]
            response = await copilotkit_stream(
                await acompletion(
                    reasoning_effort="none",
                    allowed_openai_params=["reasoning_effort"],
                    model="openai/gpt-6-luna",
                    messages=[
                        {"role": "system", "content": SYSTEM_PROMPT},
                        *self.state.messages,
                    ],
                    tools=tools,
                    parallel_tool_calls=False,
                    stream=True,
                )
            )
    ```

    `WRITE_DOCUMENT_TOOL` is a plain OpenAI-format tool schema with one
    required `document` string argument.

  </Step>
  <Step>
    ### Persist the final value

    When a Flow method finishes, **its state becomes the single source of
    truth**. The streamed predictions are not written to `self.state`, so
    assign the final value yourself. Otherwise it is overwritten when the
    method completes.

    ```python title="src/agents/shared_state_streaming.py"
            # Still inside write(), after the model call (needs `import json`)
            message = response.choices[0].message
            self.state.messages.append(message)
            calls = message.get("tool_calls") or []
            write_call = next(
                (
                    call
                    for call in calls
                    if call.get("function", {}).get("name") == "write_document"
                ),
                None,
            )
            if write_call is None:
                return

            arguments = json.loads(
                write_call.get("function", {}).get("arguments") or "{}"
            )
            document = arguments.get("document")
            self.state.document = document if isinstance(document, str) else ""
    ```

    The showcase Flow then appends a `role: "tool"` message, calls
    `copilotkit_emit_tool_result`, and asks the model for a one-line
    confirmation. See `src/agents/shared_state_streaming.py`.

  </Step>
</Steps>

<Callout title="Emit progress without a tool argument">
  To show progress that is not a tool argument, assign the value and call
  `copilotkit_emit_state` after each sub-step:

  ```python title="agent.py"
  from ag_ui_crewai import copilotkit_emit_state

  for step in steps:
      self.state.observed_steps = [*self.state.observed_steps, step]
      await copilotkit_emit_state(self.state)
      await asyncio.sleep(1)
  ```
</Callout>

The backend pattern is always the same: map one streaming tool argument to one shared-state key. Each framework does this in its own way:

- LangGraph Python: `StateStreamingMiddleware` with `StateItem(...)` entries.
- LangGraph TypeScript: `copilotkitCustomizeConfig` with an `emitIntermediateState` mapping.
- Direct SDK adapters: parse partial tool arguments in the streaming loop, and emit `STATE_SNAPSHOT` whenever the mapped value changes.
- LlamaIndex and Pydantic AI: there is no per-token mapping. A backend tool sends a state snapshot after each step or tool call instead (see the setup above).

When the model streams that argument, CopilotKit writes every partial value into shared state before the tool finishes.

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

```python title="src/agents/shared_state_streaming.py"
class SharedStateStreamingState(CopilotKitState):
    document: str = ""


class SharedStateStreamingFlow(Flow[SharedStateStreamingState]):
    """Predict write_document arguments into state, then persist the result."""

    @start()
    async def write(self) -> None:
        await copilotkit_predict_state(
            [
                StateItem(
                    state_key="document",
                    tool="write_document",
                    tool_argument="document",
                )
            ]
        )
```

</WhenFrameworkSupports>

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 tool call the model makes (`write_document.document` here).
- Streamed values are previews. When the step ends, the state the agent saves replaces them, so save the final value when the tool finishes. On CrewAI, LlamaIndex, and Pydantic AI, write the final value to the agent state yourself, or it is overwritten when the step returns.

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

The app side is the same as any other [shared-state](/react-native/crewai-crews/shared-state) subscription: `useAgent` with `OnStateChanged` gives you a live `agent.state`. Add `OnRunStatusChanged` for a "writing" indicator.

```tsx title="src/DocumentView.tsx"
import { ActivityIndicator, ScrollView, Text, View } from "react-native";
import { useAgent, UseAgentUpdate } from "@copilotkit/react-native/headless";

export function DocumentView() {
  const { agent } = useAgent({ // [!code highlight:4]
    agentId: "default",
    updates: [UseAgentUpdate.OnStateChanged, UseAgentUpdate.OnRunStatusChanged],
  });
  const document = (agent.state as { document?: string } | undefined)?.document ?? "";

  return (
    <View style={{ padding: 16, gap: 8 }}>
      {agent.isRunning ? <ActivityIndicator /> : null}
      <ScrollView style={{ maxHeight: 320 }}>
        <Text>{document}</Text>
      </ScrollView>
    </View>
  );
}
```

`agent.state.document` is a string that grows on every token, and `agent.isRunning` tells you whether to show the indicator. The `ScrollView` with a `maxHeight` keeps a long document from pushing the rest of the screen away.

If a fast stream re-renders a heavy screen too often, pass `throttleMs` to `useAgent` to batch the updates.

## Try it [#try-it]

Ask the agent to write a short poem. The `document` text grows on your screen while the agent writes. When the run ends, `agent.isRunning` is `false`, so the indicator goes away.

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