Skip to main content
POST
Stop a run
Stops a run wherever it is: mid-step, between tries, or waiting at Check with me. What its step runs on the computer is ended, without waking the computer. Steps that already ran stay as they ran; nothing is undone, and a send already under way may still land.

Path parameters

string
required
The workflow’s id, like morning-report.
string
required
The run’s run_id.

Headers

string
Who stopped it, at most 30 characters, like Claude Code.

Response

object
The run, as Get a run describes it, with state stopped.

Example

Replace $RUN_ID with the run’s run_id.

Errors

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Headers

X-Agent
string

Who you are, as the canvas names you (like Claude Code).

Maximum string length: 30

Path Parameters

id
string
required
Pattern: ^[a-z0-9-]{1,60}$
runId
string
required

Response

{ run }, stopped.

run
object
required