LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
LangGraph SDK
  • Ui
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Utils
  • Server
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
LangGraph SDK
UiClientAuthReactLoggingReact UiUtilsServer
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-sdkuiSubmitOptions
Interface●Since v1.7

SubmitOptions

Copy
interface SubmitOptions

Properties

property
checkpoint: Omit<Checkpoint, "thread_id"> | null

Checkpoint for when creating a new run.

property
command: Command

One or more commands to invoke the graph with.

property
config: ConfigWithConfigurable<ContextType>

The assistant config.

property
context: ContextType

The assistant context.

property
durability: Durability

Whether to checkpoint during the run (or only at the end/interruption).

  • "async": Save checkpoint asynchronously while the next step executes (default).
  • "sync": Save checkpoint synchronously before the next step starts.
  • "exit": Save checkpoint only when the graph exits.
property
feedbackKeys: string[]
property
interruptAfter: string[] | "*"

Interrupt execution after leaving these nodes.

property
interruptBefore: string[] | "*"

Interrupt execution before entering these nodes.

property
metadata: Metadata

The assistant metadata.

property
multitaskStrategy: MultitaskStrategy

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
onCompletion: OnCompletionBehavior

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

  • "complete": Complete the run.
  • "continue": Continue the run.
property
onDisconnect: DisconnectMode

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

  • "cancel": Cancel the run.
  • "continue": Continue the run.
property
onError: (error: unknown, run: RunCallbackMeta | undefined) => void

Callback that is called when an error occurs.

property
optimisticValues: Partial<StateType> | (prev: StateType) => Partial<StateType>
property
runId: string
property
streamMode: StreamMode[]
property
streamResumable: boolean

Mark the stream as resumable. All events emitted during the run will be temporarily persisted in order to be re-emitted if the stream is re-joined.

property
streamSubgraphs: boolean

Whether or not to stream the nodes of any subgraphs called by the assistant.

property
threadId: string

The ID of the thread to fetch history and current values from.

View source on GitHub