Method●Since v0.0

joinStream

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

joinStream(
  threadId: string | null | undefined,
  runId: string,
  options: AbortSignal | __type
): AsyncGenerator<__type>

Parameters

Name	Type	Description
`threadId`*	`string \| null \| undefined`	The ID of the thread. Can be set to `null` \| `undefined` for stateless runs.
`runId`*	`string`	The ID of the run.
`options`	`AbortSignal \| __type`	Additional options for controlling the stream behavior: signal: An AbortSignal that can be used to cancel the stream request lastEventId: The ID of the last event received. Can be used to reconnect to a stream without losing events. cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes) Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all stream modes enabled.