查询算子详情

查看一个算子的目录定义。可据此确认该算子是否适合工作流，并取得后续操作所需的算子 ID。

GET https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/$NODE_ID

调用前准备

先查询算子列表，确认要查看的算子。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和算子 ID。

下方示例使用：

• $AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。

• $WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。

• $NODE_ID：要查看的算子 ID，从查询算子列表响应中取得，并写入请求地址。

路径参数

参数	类型	是否必填	说明
node_id	string	是	要查看的算子 ID。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/workflow/v2/workitems/catalog/$NODE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

响应返回该算子的目录定义。不同类型的算子会返回不同的配置字段，因此请按目标算子的响应内容配置后续调用。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "node_id": "moi:data.sql.process",
    "display_name": "SQL 处理"
  }
}

响应字段如下。

本文中，字段路径中的 [] 表示数组中的每一项。例如，items[].name 表示 items 数组中每一项的 name 字段。

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data	object	算子目录定义；字段随算子类型变化。
data.node_id	string	算子 ID。
data.display_name	string	算子显示名称；有值时返回。
data.short_description	string	算子简短说明；有值时返回。
data.category	string	算子所属分类；有值时返回。
data.tags	string（字符串数组）	算子标签；有值时返回。
data.source	string	算子来源；有值时返回。
data.provider	string	算子提供方；有值时返回。
data.preferred_version	string	推荐使用的版本；有值时返回。
data.visibility	string	算子可见性；有值时返回。
data.versions	array	可用版本定义，按版本从新到旧排列；有值时返回。
data.versions[].version	string	版本号；有值时返回。
data.versions[].description	string	版本说明；有值时返回。
data.versions[].visibility	string	版本可见性；有值时返回。
data.versions[].stream	boolean	该版本是否为流式算子。
data.versions[].source	string	该版本的来源；有值时返回。
data.versions[].provider	string	该版本的提供方；有值时返回。
data.versions[].input_schema	string	输入 schema 的序列化内容；有值时返回。
data.versions[].output_schema	string	输出 schema 的序列化内容；有值时返回。
data.versions[].data_flow	object	数据流约定；有值时返回。
data.versions[].input_ui_schema	object	输入的界面定义；有值时返回。
data.versions[].output_ui_schema	object	输出的界面定义；有值时返回。
data.versions[].i18n	object	多语言内容，以语言标识为键；有值时返回。
data.versions[].i18n_default_locale	string	默认语言标识；有值时返回。
data.versions[].input	object	规范化的输入契约；有值时返回。
data.versions[].output	object	规范化的输出契约；有值时返回。
data.versions[].agent_context	object	算子面向智能体的上下文定义；有值时返回。
data.versions[].user_id	string	创建该版本的用户标识；有值时返回。

错误响应

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

常见 HTTP 错误

HTTP 状态码	错误代码	常见原因	建议操作
400	ErrParamInvalid	算子 ID 为空。	提供有效的算子 ID。
401	ErrUnauthorized	个人访问令牌缺失或无效。	检查个人访问令牌和工作区 ID。
403	ErrForbidden	当前身份没有读取该算子的权限。	使用有权限的凭据，或联系管理员授权。
404	ErrNotFound	算子不存在。	检查算子 ID。
500	ErrServer	服务暂时无法读取算子定义。	记录错误信息后重试。
503	ErrServiceUnavailable	依赖服务暂时不可用。	稍后重试。

后续操作

返回列表时查询算子列表。

最后更新于 2026 年 8 月 22 日