Skip to main content
POST
/
runs
"<string>"

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.

​
input

The input to the graph.

​
command
Command · object

The input to the graph.

​
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.

Available options:
values,
messages,
messages-tuple,
tasks,
checkpoints,
updates,
events,
debug,
custom
​
feedback_keys
string[]

Feedback keys to assign to run.

​
stream_subgraphs
boolean
default:false

Whether to stream output from subgraphs.

​
stream_resumable
boolean
default:false

Whether to persist the stream chunks in order to resume the stream later.

​
on_completion
enum<string>
default:delete

Whether to delete or keep the thread created for a stateless run. Must be one of 'delete' or 'keep'.

Available options:
delete,
keep
​
on_disconnect
enum<string>
default:cancel

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

Available options:
cancel,
continue
​
after_seconds
number

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

​
checkpoint_during
boolean
default:false

Whether to checkpoint during the run.

​
durability
enum<string>
default:async

Durability level for the run. Must be one of 'sync', 'async', or 'exit'.

Available options:
sync,
async,
exit

Response

Success