Skip to main content

Workflow Instances API

Runtime workflow instance management — list, view, resume, and cancel active workflows.

Endpoints Overview

MethodEndpointDescription
GET/spaces/{slug}/workflow-instancesList instances
GET/spaces/{slug}/workflow-instances/{id}Get instance
POST/spaces/{slug}/workflow-instances/{id}/resumeResume instance
POST/spaces/{slug}/workflow-instances/{id}/cancelCancel instance

List Instances

GET /spaces/{slug}/workflow-instances

Returns all workflow runtime instances for a space with current execution status.


Get Instance

GET /spaces/{slug}/workflow-instances/{instance_id}

Returns full instance details including execution graph, current node position, and variable state.


Resume Instance

POST /spaces/{slug}/workflow-instances/{instance_id}/resume

Resumes a paused workflow instance (e.g., after an approval action is completed).


Cancel Instance

POST /spaces/{slug}/workflow-instances/{instance_id}/cancel

Cancels a running or paused workflow instance.


Error Responses

StatusDescription
404Instance not found
409Instance not in a resumable/cancellable state