API Reference

Workflows

Instances

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Status

Change status of instance

client.workflows.instances.status.edit(stringworkflowName, stringinstanceId, StatusEditParams { account_id, status, from } params, RequestOptionsoptions?): StatusEditResponse { status, timestamp }

PATCH/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

ModelsExpand Collapse

StatusEditResponse { status, timestamp }

status: "queued" | "running" | "paused" | 5 more

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

timestamp: string

Accepts ISO 8601 with no timezone offsets and in UTC.

formatdate-time