Skip to main content
POST
Create Run, Wait for Output

Path Parameters

thread_id
string<uuid>
required

The ID of the thread.

Body

application/json

Payload for creating a run.

assistant_id
required

The assistant ID or graph name to run. If using graph name, will default to first assistant created from that graph.

checkpoint
Checkpoint · object

The checkpoint to resume from.

input

The input to the graph.

command
Command · object | null

The command to run.

metadata
Metadata · object

Metadata to assign to the run.

config
Config · object

The configuration for the assistant.

context
Context · object

Static context added to the assistant.

webhook
string<uri-reference>

Webhook to call after LangGraph API call is done.

Required string length: 1 - 65536
interrupt_before

Nodes to interrupt immediately before they get executed.

Available options:
*
interrupt_after

Nodes to interrupt immediately after they get executed.

Available options:
*
stream_mode

The stream mode(s) to use. lifecycle sends lifecycle|<namespace> events when a subagent (a subgraph) starts and ends: {"event": "started" | "completed" | "failed" | "interrupted", "namespace", "tool_call_id"?, "error"?}, with the id of the tool call that started it, with or without stream_subgraphs. tools sends on_tool_start, on_tool_event, on_tool_end and on_tool_error events with toolCallId and name (from langgraph 1.2.19 and @langchain/langgraph 1.6.0; a tool error's text is never sent).

Available options:
values,
messages,
messages-tuple,
tasks,
checkpoints,
updates,
events,
debug,
custom,
tools,
lifecycle
stream_subgraphs
boolean
default:false

Whether to stream output from subgraphs.

stream_resumable
boolean
default:false

Whether to keep the run's stream events so a client can rejoin the run. Deployments keep every run's events for RESUMABLE_STREAM_TTL_SECONDS (2 minutes by default) regardless of this field. The in-memory runtime (langgraph dev) keeps them only when it is true.

strict_resume
boolean
default:false

Refuse a command.resume that names an interrupt that isn't pending, before the graph runs: the run ends with UnknownInterruptError and the thread keeps its state. Needs a langgraph version with strict resume; /info reports strict_resume when it is available.

feedback_keys
string[]

Generate pre-signed URLs for assigning feedback keys to the run.

For each key specified, a unique URL will be generated that can be called to assign the feedback key to the run. See LangSmith Feedback for more details.

multitask_strategy
enum<string>
default:enqueue

Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.

Available options:
reject,
rollback,
interrupt,
enqueue
if_not_exists
enum<string>
default:reject

How to handle missing thread. Must be either 'reject' (raise error if missing), or 'create' (create new thread).

Available options:
create,
reject
after_seconds
number

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

checkpoint_during
boolean
default:false
deprecated

Whether to checkpoint during the run.

Deprecated. Use durability instead to control checkpoint persistence behavior during the run.

durability
enum<string>
default:async

Durability level for the run. Must be one of sync, async, or exit. See durability modes for more details.

Available options:
sync,
async,
exit
on_disconnect
enum<string>
default:continue

The disconnect mode to use. Must be one of 'cancel' or 'continue'.

Available options:
cancel,
continue

Response

Success