LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
React SDK
Vue SDK
Svelte SDK
Angular SDK
LangGraph SDK
  • Ui
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Utils
  • Server
  • Stream
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
  • Store
LangGraph Checkpoint Redis
  • Shallow
  • Store
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
  • Cli
LangGraph API
LangGraph CLI
LangGraph CUA
  • Utils
LangGraph Supervisor
LangGraph Swarm
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangGraph
WebChannelsPregelPrebuiltRemote
React SDK
Vue SDK
Svelte SDK
Angular SDK
LangGraph SDK
UiClientAuthReactLoggingReact UiUtilsServerStream
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
Store
LangGraph Checkpoint Redis
ShallowStore
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
Cli
LangGraph API
LangGraph CLI
LangGraph CUA
Utils
LangGraph Supervisor
LangGraph Swarm
Language
Theme
JavaScript@langchain/langgraph-sdkindexThreadStreamOptions
Interface●Since v2.0

ThreadStreamOptions

Options for ThreadStream construction.

Copy
interface ThreadStreamOptions

Properties

property
assistantId: string
property
fetch: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response>

Optional fetch override, forwarded to the SSE transport. Useful for auth proxies, Next.js route handlers, or tests with injected mocks. Ignored when webSocketFactory is also supplied.

property
startingCommandId: number

Starting command ID for the internal command counter. Mostly useful for tests.

property
transport: ThreadStreamTransport

How this thread talks to the agent server. Accepts either a built-in transport string or a custom AgentServerAdapter:

  • "sse": HTTP commands + one SSE event stream per subscription.
  • "websocket": single bidirectional WebSocket.
  • an AgentServerAdapter: custom transport that replaces the built-in factories entirely. fetch / webSocketFactory are ignored in this mode.

Defaults to the client-level streamProtocol ("v2-websocket" → "websocket", otherwise "sse").

property
webSocketFactory: (url: string) => WebSocket

Optional WebSocket factory. Supplying it flips the adapter into WebSocket mode — SSE is bypassed entirely.

View source on GitHub