Interface RunsInvokePayload

interface RunsInvokePayload {
    afterSeconds?: number;
    checkpoint?: Omit<Checkpoint, "thread_id">;
    checkpointDuring?: boolean;
    checkpointId?: string;
    command?: Command;
    config?: Config;
    ifNotExists?: "reject" | "create";
    input?: null | Record<string, unknown>;
    interruptAfter?: string[] | "*";
    interruptBefore?: string[] | "*";
    metadata?: Metadata;
    multitaskStrategy?: MultitaskStrategy;
    onCompletion?: OnCompletionBehavior;
    onDisconnect?: DisconnectMode;
    onRunCreated?: ((params) => void);
    signal?: AbortSignal;
    webhook?: string;
}

Properties

afterSeconds? checkpoint? checkpointDuring? checkpointId? command? config? ifNotExists? input? interruptAfter? interruptBefore? metadata? multitaskStrategy? onCompletion? onDisconnect? onRunCreated? signal? webhook?

Properties

Optional afterSeconds

afterSeconds?: number

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

Optional checkpoint

checkpoint?: Omit<Checkpoint, "thread_id">

Checkpoint for when creating a new run.

Optional checkpointDuring

checkpointDuring?: boolean

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

Optional checkpointId

checkpointId?: string

Checkpoint ID for when creating a new run.

Optional command

command?: Command

One or more commands to invoke the graph with.

Optional config

config?: Config

Additional configuration for the run.

Optional ifNotExists

ifNotExists?: "reject" | "create"

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

Optional input

input?: null | Record<string, unknown>

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

Optional interruptAfter

interruptAfter?: string[] | "*"

Interrupt execution after leaving these nodes.

Optional interruptBefore

interruptBefore?: string[] | "*"

Interrupt execution before entering these nodes.

Optional metadata

metadata?: Metadata

Metadata for the run.

Optional multitaskStrategy

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.

Optional onCompletion

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.

Optional onDisconnect

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.

Optional onRunCreated

onRunCreated?: ((params) => void)

Callback when a run is created.

Type declaration

    • (params): void

    • Parameters

      • params: {
            run_id: string;
            thread_id?: string;
        }
        • run_id: string
        • Optional thread_id?: string

      Returns void

Optional signal

signal?: AbortSignal

Abort controller signal to cancel the run.

Optional webhook

webhook?: string

Webhook to call when the run is complete.

Settings

Member Visibility

Theme

On This Page

afterSecondscheckpointcheckpointDuringcheckpointIdcommandconfigifNotExistsinputinterruptAfterinterruptBeforemetadatamultitaskStrategyonCompletiononDisconnectonRunCreatedsignalwebhook