Create Background Run

Create a run in existing thread, return the run ID immediately. Don't wait for the final run output.

thread_idstring uuid required

The ID of the thread.

Request body

sandbox_environment_idstring uuid

Sandbox environment ID to force using the specified container.

metadataobject

Metadata to assign to the run.

webhookstring uri

Webhook to call after LangGraph API call is done.

stream_subgraphsboolean

Whether to stream output from subgraphs.

on_disconnect'cancel' | 'continue'

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

feedback_keysstring[]

Feedback keys to assign to run.

multitask_strategy'reject' | 'rollback' | 'interrupt' | 'enqueue'

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

if_not_exists'create' | 'reject'

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

after_secondsinteger

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

Success

run_idstring uuid required

The ID of the run.

thread_idstring uuid required

The ID of the thread.

assistant_idstring uuid required

The assistant that was used for this run.

created_atstring date-time required

The time the run was created.

updated_atstring date-time required

The last time the run was updated.

status'pending' | 'error' | 'success' | 'timeout' | 'interrupted' required

The status of the run. One of 'pending', 'error', 'success', 'timeout', 'interrupted'.

metadataobject required

The run metadata.

kwargsobject required

multitask_strategy'reject' | 'rollback' | 'interrupt' | 'enqueue' required

Strategy to handle concurrent runs on the same thread.