启动工作流作业¶

启动一个工作流作业。请求成功表示服务已受理启动，不表示作业已完成。

POST https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/{workflow_id}/executions

调用前准备¶

先查看工作流详情，确认要启动的工作流。准备具有工作流运行权限的个人访问令牌和目标工作区 ID。

路径参数¶

参数	类型	是否必填	说明
`workflow_id`	string	是	工作流 ID。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$WORKFLOW_ID 和示例中的运行输入替换为实际值。

输入示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/workflow/v2/workflow-apps/$WORKFLOW_ID/executions" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "values": {
      "input_file": "file-001"
    },
    "trigger_now": true,
    "run_once": true
  }'

参数说明

参数	类型	是否必填	说明
`values`	object	否	运行时输入；键由工作流的运行时表单定义。
`trigger_now`	boolean	否	是否立即触发运行。
`run_once`	boolean	否	是否只运行一次。
`execution_mode`	string	否	本次运行使用的执行方式。
`compute_resource_id`	string	否	本次运行使用的计算资源 ID。

成功响应¶

成功时返回 200 和新作业。记录 data.workflow_run.execution_id，用于查询状态和结果。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workflow_run": {
      "execution_id": "run-001",
      "workflow_id": "wf-001",
      "status": "queued",
      "execution_mode": "one_shot"
    }
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。
`workflow_run`	object	新建的作业。

作业信息

下面表格展开响应示例中 data 下的 workflow_run 对象；每一行是该对象的一个字段。

字段	类型	说明
`execution_id`	string	作业 ID。
`workflow_id`	string	工作流 ID。
`status`	string	当前作业状态。
`available_actions`	array of string	当前状态下允许的操作。
`execution_mode`	string	本次运行的执行方式。
`moi_task_id`	string	服务端任务标识；有值时返回。
`moi_case_id`	string	服务端案例标识；有值时返回。
`moi_workflow_def_id`	string	工作流定义标识；有值时返回。
`moi_workflow_version_id`	string	工作流版本标识；有值时返回。
`pause_scope`	string	暂停范围；有值时返回。
`error`	string	错误信息；有值时返回。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

使用 data.workflow_run.execution_id 查看工作流作业详情或查看工作流作业结果。

最后更新于 2026 年 9 月 3 日