Skip to content

workflow/pause

Pauses a live workflow run; admission-only bare ack, the pause folds as the workflow item’s paused member.

Type: WorkflowPauseParams

workflow/pause params: pause a live workflow run, shaped exactly like workflow/cancel.

Field Type Stability Presence Description
commandId string required The idempotency handle (UUIDv7).
sessionId string required The target session.
workflowRunId string required The run to pause, exactly as the workflow item names it; required, non-empty.
Source

schema/msp/experimental/msp.schema.json#/methods/workflow~2Fpause

{
"description": "Pauses a live workflow run; admission-only bare ack, the pause folds as the workflow item's `paused` member.",
"params": {
"$ref": "#/$defs/WorkflowPauseParams"
},
"result": {
"$ref": "#/$defs/WorkflowControlResult"
}
}