Skip to main content
GET
查询工作流详情

查询工作流详情

根据工作流 ID 查询当前 API Key 可访问的已发布版本详情。提交运行前,应先读取 editable_parameter_manifest,再按参数清单组装 inputs
版本说明: 返回的 revision_id 是当前可访问的已发布版本。提交运行时可以传入该值来锁定本次调用的版本。
可见范围: 支持查询公开发布的工作流,也支持查询当前 API Key 所属用户自己已发布的非公开工作流。

请求参数

string
required
工作流 ID

响应参数

integer
响应码,0 表示成功
string
响应信息
object
工作流详情

editable_parameter_manifest 输入参数清单

组装运行请求时,先遍历 editable_parameter_manifest,再以每个条目的 name 为 key 写入 inputs。不要使用 display_namebindings[].field 或文档旧版本中的 key 字段;执行引擎会拒绝 manifest 中未声明的输入参数。

基础类型填写方式

图片、视频、音频和通用文件参数分别由 image_input/imagevideo_input/videoaudio_input/audiofile_input/file 标识。服务端还兼容部分历史别名;调用方应以当前详情响应实际返回的 value_type 为准。

必填项和默认值

  • required=true:必须在 inputs 中提供该 name,否则运行会失败
  • required=false:可以省略,工作流会保留发布版本中保存的节点值
  • default_value:用于展示或预填。为了让调用结果可预测,必填参数以及需要固定值的可选参数都应显式传入,不要仅依赖该字段

下拉选择

当条目返回 ui_schema.control="select" 时,可选列表就在 ui_schema.options 中:
提交时传选中项的 value,不是 labelvalue 可能是字符串、数字或布尔值,必须保留其原始 JSON 类型。选项由工作流对应的 ComfyUI 节点定义动态生成,不存在平台统一的固定列表。

数字范围

当前 editable_parameter_manifest 不返回 minimummaximumstep 字段,开放接口也无法从清单中推导数值边界。请按 descriptiondefault_value 和具体工作流约定填写;超出底层 ComfyUI 节点支持范围的值可能在执行阶段失败。文档不会把某个工作流的数值范围套用到其他工作流。

文件和资源 ID

本地图片、视频、音频或其他文件不能直接放入 JSON。请先调用 上传工作流资源,然后把响应中的 asset_uri 作为对应参数值:
如果手中只有 asset_id,请拼成 asset://<asset_id>;不要只传裸值 asset_xxx。文件参数也支持服务端可访问的 http://https:// 地址以及 data:<mime>;base64,...,但本地文件和较大文件建议统一先上传。资源必须属于当前调用者且媒体类型要与参数类型匹配。

candidate_output_manifest 输出参数清单

该清单只描述运行结果,不需要放入提交接口的 inputstype 决定结果按图片、视频还是音频展示;node_id + output_key + file_index 精确定位 ComfyUI 输出。查询运行详情或执行结果时,应优先使用清单中的 nametype 识别输出,不要根据文件扩展名猜测类型。

代码示例

响应示例