Parameters
| Name | Type | Required | Meaning |
|---|---|---|---|
instance_id |
string | yes | The instance to cancel. |
reason |
string | no | Why. Kept with the instance. |
Notes
Cancelling stops the engine from issuing further steps. It does not undo anything the agent already did: files written, commands run and child workflows that completed stay as they are. The engine's own cancellation of a hierarchy — a stop step — works the same way and cancels every child instance with the root.
Agents are expected to confirm with the person before cancelling work in flight.