Menu
Language
Theme
Base interface for a single subagent stream. Tracks the lifecycle of a subagent from invocation to completion.
Extends StreamBase to share common properties with UseStream, allowing subagents to be treated similarly to the main stream.
Prefer using SubagentStream which supports passing an agent type directly for automatic type inference.
interface SubagentStreamInterfaceCurrently active subagents (where status === "running").
When the subagent completed
Nesting depth (0 = called by main agent, 1 = called by subagent, etc.)
Last seen error from the stream.
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.
Unique identifier (the tool call ID)
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.
Namespace path for this subagent execution
Tool call ID of parent subagent (for nested subagents)
Final result content (when complete)
When the subagent started
Current execution status
All currently active and completed subagent streams. Keyed by tool call ID for easy lookup.
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).
The tool call that invoked this subagent
Tool calls paired with their results. Useful for rendering tool invocations and their outputs together.
The current state values of the stream.