LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
LangGraph SDK
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • 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
ClientAuthReactLoggingReact UiServer
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-sdkindexRunsInvokePayload
Interface●Since v0.0

RunsInvokePayload

Copy
interface RunsInvokePayload

Properties

property
afterSeconds: number

The number of seconds to wait before starting the run. Use to schedule future runs.

property
checkpoint: Omit<Checkpoint, "thread_id">

Checkpoint for when creating a new run.

property
checkpointId: string

Checkpoint ID for when creating a new run.

property
command: Command

One or more commands to invoke the graph with.

property
config: Config

The assistant config.

property
context: unknown

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
ifNotExists: "reject" | "create"

Behavior if the specified run doesn't exist. Defaults to "reject".

property
input: Record<string, unknown> | null

Input to the run. Pass null to resume from the current state of the thread.

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
onRunCreated: (params: __type) => void

Callback when a run is created.

property
signal: AbortSignal

Abort controller signal to cancel the run.

property
webhook: string

Webhook to call when the run is complete.

deprecatedproperty
checkpointDuring: boolean

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

View source on GitHub