Get workflow version by number¶
Reads details of a single workflow version by its 1-based positive integer version number across draft, published, and deprecated statuses.
GET https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/{workflow_id}/versions/by-number/{version_number}
Before you begin¶
Prepare a personal access token with workflow version read permission and the target workspace ID.
Call List workflow versions to confirm the target workflow ID and an existing positive integer version number.
Request parameters¶
Replace $AI_STUDIO_API_KEY, $WORKSPACE_ID, $WORKFLOW_ID, and $VERSION_NUMBER with actual values.
curl "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/versions/by-number/$VERSION_NUMBER" \
-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. |
|
integer |
Yes |
Positive integer version number ( |
Successful response¶
Returns HTTP 200 and the matching workflow version object. Version object keys use PascalCase on the JSON wire.
{
"code": "OK",
"msg": "OK",
"data": {
"ID": "ver-002",
"WorkspaceID": "ws-001",
"UserID": "user-001",
"WorkflowDefinitionID": "def-001",
"Version": 2,
"WorkflowJSON": "{\"name\":\"daily-import\",\"nodes\":[]}",
"Status": "draft",
"CreatedBy": "user-001",
"CreatedAt": "2026-10-14T09:00:00Z",
"PublishedAt": "0001-01-01T00:00:00Z",
"Type": 1,
"InputSchema": "",
"OutputSchema": "",
"ResultMode": 0,
"Description": "Add input field validation",
"RuntimeSpecJSON": ""
}
}
Field |
Type |
Description |
|---|---|---|
|
string |
|
|
string |
Result message; |
|
object |
Matching 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 matching |
|
string |
Saved workflow definition JSON string. |
|
string |
Version status: |
|
string |
User ID of the actor who created the version. |
|
string |
Version creation time in RFC 3339 format. |
|
string |
Version publication time 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 400 (ErrParamInvalid) when version_number cannot be parsed as an integer, and 404 (ErrNotFound) when the workflow or requested version number does not exist. Passing a version_number less than 1 also fails because a positive version number is required.
{
"code": "ErrNotFound",
"msg": "Not Found"
}
Field |
Type |
Description |
|---|---|---|
|
string |
Error code, such as |
|
string |
Human-readable error message. |