State Streaming
Stream partial agent state to your React Native UI while a tool call is still running.
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?
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
The backend: one streaming state mapping
Install the CopilotKit LangGraph SDK
npm install @copilotkit/sdk-jsMap generated content into shared state while it streams
Extend your graph state with CopilotKitStateAnnotation, then call
copilotkitCustomizeConfig with an emitIntermediateState mapping. This
forwards the write_document.document tool argument into state.document
while the model is still generating it.
const streamingConfig = copilotkitCustomizeConfig(config, {
emitIntermediateState: [
{
stateKey: "document",
tool: "write_document",
toolArgument: "document",
},
],
});
const response = await modelWithTools.invoke(
[systemMessage, ...state.messages],
streamingConfig,
);To push progress from your own code instead of a tool call, call
copilotkitEmitState with the state you want the UI to show:
import { copilotkitEmitState } from "@copilotkit/sdk-js/langgraph";
for (const step of steps) {
state.observed_steps = [...(state.observed_steps ?? []), step];
await copilotkitEmitState(config, state);
}Streamed values are previews. When the node finishes, the state it returns replaces them, so return every key you want to keep, or the UI loses the streamed value.
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:
StateStreamingMiddlewarewithStateItem(...)entries. - LangGraph TypeScript:
copilotkitCustomizeConfigwith anemitIntermediateStatemapping. - Direct SDK adapters: parse partial tool arguments in the streaming loop, and emit
STATE_SNAPSHOTwhenever 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.
const streamingConfig = copilotkitCustomizeConfig(config, {
emitIntermediateState: [
{
stateKey: "document",
tool: "write_document",
toolArgument: "document",
},
],
});
const response = await modelWithTools.invoke(
[systemMessage, ...state.messages],
streamingConfig,
);A few things to note:
- The state key must exist in your agent state (
documentin this example). - The tool and argument names must match the exact tool call the model makes (
write_document.documenthere). - 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 app side is the same as any other shared-state subscription: useAgent with OnStateChanged gives you a live agent.state. Add OnRunStatusChanged for a "writing" indicator.
import { ActivityIndicator, ScrollView, Text, View } from "react-native";
import { useAgent, UseAgentUpdate } from "@copilotkit/react-native/headless";
export function DocumentView() {
const { agent } = useAgent({
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
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.
How is this guide?