Skip to content

workflow_killswitch_set

Stop or resume every workflow of this Product.

Tool

workflow_killswitch_set

Stop or resume every workflow of this Product.

Stop or resume every workflow of this Product. Turning it on holds the runs that are running, waiting or queued and expires their waits — nothing is lost, and `workflow_run_replay_all` restarts them afterwards.

Behavior

HTTP
POST /workflow/killswitch

Arguments

Name
Type
Required
Description
on
boolean
•
True stops this Product's workflows; false lets them run again.

Response

Field
Type
Always
Description
at
string
•
by
string
•
The identity that last flipped the switch.
on
boolean
•
forced
boolean
•
True when the platform holds it on for every Product (WORKFLOW_KILLSWITCH=1).
stopped_runs
number
•
Runs this call moved to `held`: everything that was running, waiting or queued.

Try it

Stop or resume every workflow of this Product.

When to use

Stop or resume every workflow of this Product. Turning it on holds the runs that are running, waiting or queued and expires their waits — nothing is lost, and `workflow_run_replay_all` restarts them afterwards.

Example

Ask your agent something like this:

Stop or resume every workflow of this Product.

The agent will invoke workflow_killswitch_set with these arguments:

{
  "on": "<on>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select