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-sdkstreamStreamSubmitOptions
Interface●Since v2.0

StreamSubmitOptions

Copy
interface StreamSubmitOptions

Properties

property
_stateType: StateType
property
command: __type

One or more commands to invoke the graph with.

property
config: __type

The assistant config.

property
forkFrom: __type

Fork the run from an explicit checkpoint instead of the thread's latest. Emits a forkFrom field on the /run.start request that the API layer forwards to graph.streamEvents(input, { version: "v3", forkFrom }).

See plan-roadmap.md §5.3 R2.4.

property
metadata: Record<string, unknown>
property
multitaskStrategy: "reject" | "interrupt" | "rollback" | "enqueue"

Strategy to handle concurrent runs on the same thread. Only relevant if there is a pending/inflight run on the same thread. One of:

  • "reject": Reject the new run.
  • "interrupt": Interrupt the current run, keeping steps completed until now, and start a new one.
  • "rollback": Cancel and delete the existing run, rolling back the thread to the state before it had started, then start the new run.
  • "enqueue": Queue up the new run to start after the current run finishes.
property
onError: (error: unknown) => void

Callback that is called when an error occurs.

property
signal: AbortSignal

Abort controller signal to cancel the run.

property
threadId: string | null

Thread ID this transport is bound to.

View source on GitHub