Menu
Language
Theme
interface UseStreamOmit<StreamBase<StateType, GetToolCallsType<StateType>, GetInterruptType<Bag>, SubagentStates>, "messages">Currently active subagents (where status === "running").
The ID of the assistant to use.
The current branch of the thread.
LangGraph SDK client used to send request and receive responses.
Last seen error from the stream.
Tree of all branches for the thread.
Get the metadata for a message, such as first thread state the message was seen in and branch information.
Get subagent stream by tool call ID.
Get all subagents triggered by a specific AI message.
Useful for rendering subagent activities grouped by the AI message (and therefore conversation turn) that spawned them.
// Render subagents after each AI message that triggered them
{stream.messages.map((msg) => (
<div key={msg.id}>
<MessageBubble message={msg} />
{msg.type === "ai" && "tool_calls" in msg && (
<SubagentPipeline
subagents={stream.getSubagentsByMessage(msg.id)}
/>
)}
</div>
))}Get all subagents of a specific type. When called with a literal type name that matches a key in SubagentStates, returns streams with properly inferred state types.
// With DeepAgent type inference
const stream = useStream<typeof agent>(...);
const researchers = stream.getSubagentsByType("researcher");
// researchers[0].values is typed with ResearcherMiddleware stateGet tool calls for a specific AI message.
Flattened history of thread states of a thread.
Get the interrupt value for the stream if interrupted.
Convenience alias for interrupts[0].
All current interrupts from the stream. When using Send() fan-out with per-task interrupt() calls, multiple interrupts may be pending simultaneously.
Whether the stream is currently running.
Whether the thread is currently being loaded.
Messages accumulated during the stream as @langchain/core class instances.
Server-side submission queue. Pending runs created via
multitaskStrategy: "enqueue" when submitting while the agent is busy.
Set the branch of the thread.
Stops the stream.
All currently active and completed subagent streams. Keyed by tool call ID for easy lookup.
Create and stream a run to the thread.
Switch to a different thread, clearing the current stream state.
Pass null to reset to no thread (a new thread will be created on next submit).
Tool calls paired with their results. Useful for rendering tool invocations and their outputs together.
Progress of tool executions during streaming.
The current state values of the stream.