StreamOrchestrator

Cancel and remove a specific pending run from the queue. If the run exists and a thread is active, the run is also cancelled on the server.

Remove all pending runs from the queue and cancel them on the server.

Tear down the orchestrator. Marks the instance as disposed, unsubscribes from the stream, and aborts any in-progress stream. After calling this method, no further notifications will be emitted.

Trigger queue draining. Framework adapters should call this when isLoading or queue size changes.

Retrieve stream-level metadata for a given message.

Return the current version number, incremented on each state change. Useful as a cache key for external sync (e.g. useSyncExternalStore).

Look up a single subagent stream by its tool call ID.

Retrieve all subagent streams associated with a specific AI message.

Retrieve all subagent streams matching a given tool name / type.

Get tool calls (with results) that belong to a specific AI message.

Trigger initial history fetch for the current thread ID. Should be called once after construction when the initial threadId is known.

Stream output from a run in real-time, until the run is done.

Reconstruct subagent streams from history values when subagent filtering is enabled and the stream is not currently loading. This is a no-op if subagents are already populated.

Update the current branch and notify listeners.

Update thread ID from an external source (e.g. reactive prop change). Clears the current stream and triggers a history fetch.

Abort the current stream and invoke the onStop callback if one was provided in the options.

Submit input values and start a new stream run.

Delegates to submitDirect. Override or wrap this method in framework adapters to add queuing or other middleware.

Start a new stream run against the custom transport.

This is the low-level submit entry point that handles thread ID resolution, optimistic value merging, and transport invocation. Prefer submit unless you need to bypass higher-level wrappers.

Register a listener that is called whenever the orchestrator state changes.

Switch to a different thread. If the thread ID actually changed, the current stream is cleared and listeners are notified.

Custom transports do not negotiate stream modes with the server the way LangGraph Platform streams do, but framework adapters call this method on both orchestrator variants. Keep the API surface aligned as a no-op.

Attempt to reconnect to a previously running stream. Returns true if a reconnection was initiated.