Workflow Versions
Tags: versions, workflows
Endpoints
GET- ListPOST- CreateGET /active- ActiveGET /diff- DiffGET /{version_number}- Get Version NumberPATCH /{version_number}- Update Version NumberPOST /{version_number}/activate- ActivatePOST /{version_number}/deactivate- Deactivate
List
GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
List all published versions of a workflow, newest first.
Authorization: Requires workflows:read scope
Parameters:
workflow_uuid(String)
Response: See WorkflowVersionListResponse
Create
POST /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
Publish the current live workflow as a new immutable version.
Authorization: Requires workflows:write scope
Parameters:
workflow_uuid(String)request- See PublishVersionRequest
Response: See WorkflowVersionResponse
Active
GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/active
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
Get the active published version with full snapshot.
Authorization: Requires workflows:read scope
Parameters:
workflow_uuid(String)
Response: See WorkflowVersionDetailResponse
Diff
GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/diff
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
Compare two workflow versions and return a structured diff.
Version number 0 means the current live draft workflow. Includes field-level detail with old/new text values for prompts, descriptions, agent identity, etc.
Authorization: Requires workflows:read scope
Parameters:
workflow_uuid(String)from_version(Integer)to_version(Integer)
Response: See WorkflowVersionDiffResponse
Get Version Number
GET /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
Get a specific version by number with full snapshot.
Authorization: Requires workflows:read scope
Parameters:
workflow_uuid(String)version_number(Integer)
Response: See WorkflowVersionDetailResponse
Update Version Number
PATCH /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
Update mutable metadata (name, changeSummary) of a published version.
Authorization: Requires workflows:write scope
Parameters:
workflow_uuid(String)version_number(Integer)request- See UpdateVersionRequest
Response: See WorkflowVersionResponse
Activate
POST /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}/activate
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
Activate a version to receive new assignments.
Authorization: Requires workflows:write scope
Parameters:
workflow_uuid(String)version_number(Integer)
Response: See WorkflowVersionResponse
Deactivate
POST /api/v2/w/{workspace_uuid}/workflows/{workflow_uuid}/versions/{version_number}/deactivate
Description:
Draft/publish lifecycle for workflows. The live workflow is the draft; published versions are immutable snapshots.
Deactivate a version so it no longer receives new assignments.
Authorization: Requires workflows:write scope
Parameters:
workflow_uuid(String)version_number(Integer)
Response: See WorkflowVersionResponse