Deprecate a workflow version¶
Marks a published workflow version as deprecated. Only versions in published status can be deprecated; to remove an unpublished draft version, call Delete a workflow version.
POST https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/{workflow_id}/versions/{version_id}/deprecate
Before you begin¶
Prepare a personal access token with workflow version deprecate permission and the target workspace ID.
Call List workflow versions or Get latest published workflow version to obtain the target version
ID, verify that itsStatusispublished, and confirm that the workflow is not managed by an agent automation task.
Request parameters¶
Replace $AI_STUDIO_API_KEY, $WORKSPACE_ID, $WORKFLOW_ID, and $VERSION_ID with actual values.
curl -X POST "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/versions/$VERSION_ID/deprecate" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
Path parameters
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Target workflow ID, obtained from List workflows. |
|
string |
Yes |
Published version ID to deprecate ( |
Successful response¶
Returns HTTP 200 and the updated workflow version object with Status set to deprecated. Version object keys use PascalCase on the JSON wire.
{
"code": "OK",
"msg": "OK",
"data": {
"ID": "ver-001",
"WorkspaceID": "ws-001",
"UserID": "user-001",
"WorkflowDefinitionID": "def-001",
"Version": 1,
"WorkflowJSON": "{\"name\":\"daily-import\",\"nodes\":[]}",
"Status": "deprecated",
"CreatedBy": "user-001",
"CreatedAt": "2026-10-14T08:00:00Z",
"PublishedAt": "2026-10-14T08:05:00Z",
"Type": 1,
"InputSchema": "",
"OutputSchema": "",
"ResultMode": 0,
"Description": "Initial published version",
"RuntimeSpecJSON": ""
}
}
Field |
Type |
Description |
|---|---|---|
|
string |
|
|
string |
Result message; |
|
object |
Updated workflow version object. |
|
string |
Workflow version ID. |
|
string |
Workspace ID that owns the version. |
|
string |
User ID of the workflow owner. |
|
string |
Workflow definition ID that owns the version. |
|
integer |
Positive integer version number starting from |
|
string |
Saved workflow definition JSON string. |
|
string |
Version status after deprecation; |
|
string |
User ID of the actor who created the version. |
|
string |
Version creation time in RFC 3339 format. |
|
string |
Original publication time of the version in RFC 3339 format. |
|
integer |
Version type code: |
|
string |
Saved input schema JSON string; |
|
string |
Saved output schema JSON string; |
|
integer |
Result mode code: |
|
string |
Version description; |
|
string |
Saved runtime specification JSON string; |
Error response¶
Returns 404 (ErrNotFound) when the workflow or version does not exist, and 409 (ErrWorkflowUpdateManagedByAutomation) when the workflow is managed by an agent automation task. Calling this endpoint on a draft or already deprecated version fails because only published versions can be deprecated.
{
"code": "ErrNotFound",
"msg": "Not Found"
}
Field |
Type |
Description |
|---|---|---|
|
string |
Error code, such as |
|
string |
Human-readable error message. |