启用自定义算子

启用一个自定义算子，使其可用于后续的工作流配置和试运行。

POST https://api.moi.matrixorigin.cn/v5/workflow/v2/custom-operators/$OPERATOR_ID/enable

调用前准备

先查看自定义算子列表，选择一个算子并取得自定义算子 ID；再查看自定义算子详情，确认该算子的当前状态。将该 ID 写入路径参数 operator_id。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID，分别通过 X-API-Key 和 X-Workspace-ID 请求头传递。

路径参数

curl -X POST "https://api.moi.matrixorigin.cn/v5/workflow/v2/custom-operators/$OPERATOR_ID/enable" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

字段

类型

是否必填

说明

operator_id

integer

必填

要启用的自定义算子 ID。

成功响应

响应返回更新后的算子配置。只有已启用的 Python 代码类型才可试运行自定义算子。

响应字段如下。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 123,
    "node_id": "moi:custom.operator:workspace:text_counter",
    "name": "文本计数",
    "enabled": true
  }
}

字段

类型

是否必填

说明

code

string

否

成功时为 OK。

msg

string

否

成功时为 OK。

data.id

integer

否

自定义算子 ID。

data.node_id

string

否

工作流中的算子 ID。

data.name

string

否

算子名称。

data.enabled

boolean

否

更新后的启用状态。

错误响应

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

字段

类型

是否必填

说明

code

string

否

错误代码。

msg

string

否

可读错误信息。

data

null

否

错误响应中为 null。

后续操作

完成后使用同一自定义算子 ID 查看自定义算子详情确认当前状态。

最后更新于