Menu
Language
Theme
Base stream interface shared by all stream types.
Contains core properties for state management, messaging, and stream control that are common to CompiledStateGraph, ReactAgent, and DeepAgent streams.
This interface provides the foundation that all stream types build upon:
values, isLoading, error)messages)interrupt)submit, stop)branch, history)interface BaseStream// BaseStream is not used directly - use one of the specialized interfaces:
// - UseGraphStream for CompiledStateGraph
// - UseAgentStream for ReactAgent (createAgent)
// - UseDeepAgentStream for DeepAgent (createDeepAgent)The current branch of the thread. Used for navigating between different conversation branches.
LangGraph SDK client used to send requests and receive responses.
Get the metadata for a message, such as first thread state the message was seen in and branch information.
Flattened history of thread states of a thread. Contains all states in the current branch's history.
Current interrupt, if the stream is interrupted.
Convenience alias for interrupts[0].
For workflows with multiple concurrent interrupts, use interrupts instead.
Interrupt payloads collected during the run, if any.
Mirrors the in-process run.interrupts.
Whether the stream is currently running.
true while streaming, false when idle or completed.
Whether the thread is currently being loaded.
true during initial thread data fetch.
Join an active stream that's already running.
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 currently running stream.
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).
Progress of tool executions during streaming. Populated when stream mode includes "tools" and tools yield or report progress.