提交工作流任务 - comfy_prompt

更新时间:

接口说明

提交工作流任务

前提条件

已接入智作工坊SDK SDK参考

授权方式

AK/SK,获取方式参考 API授权

接入地址

https://openai.edu-aliyun.com

调用路径

/scc/comfy_prompt

请求参数

请求协议

application/json

请求头(Headers)

名称

类型

必填

描述

X-SP-RESOURCE-CONFIG-ID

string

可选

资源池配置 ID,格式参考 资源池配置参数格式说明

请求体(Body)

名称

类型

必填

描述

workflow_id

string

必填

工作流ID,固定值,可以在工作流管理里拷贝

alias_id

string

可选(alias_id 和 version_id 必填一个)

工作流别名,别名可以理解为指向特定版本的指针。您可以利用别名来轻松实现发布、回滚等操作

version_id

string

可选(alias_id 和 version_id 必填一个)

工作流版本号,系统自增值,您也可以指定版本请求特定版本的接口,eg: v1, v2..

randomise_seeds

bool

可选,默认 false

自动将工作流的所有 seed 字段改为随机值,避免命中 ComfyUI 缓存

return_temp_files

bool

可选,默认 false

是否返回工作流中的临时图片,eg: 预览结果...

inputs

object

必填

inputs 的格式跟具体工作流有关,为您在工作流发版时配置的字段映射。以下内容是一个示例

ref_image

string

示例字段,跟具体工作流有关

参考图片,如果输入参数为文件类型,格式请参考: 图片字段格式说明

steps

integer

步数

cfg

double

默认1.5

denoise

double

默认1,最大1

negative

string

反向提示词

prompt

string

正向提示词

width

integer

宽度

height

integer

高度

返回参数

名称

类型

描述

status

integer

网关状态码,10: 成功,20: 失败

apiInvokeId

string

系统生成的标志本次调用的id。

errCode

string

网关错误码,成功忽略。

errMessage

string

网关错误详情,成功忽略。

subErrCode

string

服务错误码,成功忽略。

subErrMessage

string

服务错误详情,成功忽略。

data

object

服务返回结果

taskId

string

生图任务ID

status

string

任务状态,任务成功:succeeded;任务执行失败:failed;任务执行中:running;排队中:waiting。

示例

说明

网关状态码 status 为 10 时表示任务提交成功,可以获取对应的异步 taskId

{
    "status": 10,        // 网关状态码,10: 成功,20: 失败
    "apiInvokeId": "i_66c587a7c6fd500028c10e78",
    "data": {
        "taskId": "01j5ssksqndptm3exv751bz0gj",
        "status": "waiting"
    },
    "subErrCode": null,   // 服务错误码
    "subErrMessage": null,// 服务错误详情
    "errCode": null,      // 网关错误码
    "errMessage": null,   // 网关错误详情
}

网关错误码

错误代码表

服务错误码

网关错误码(subErrCode)

错误信息 Message

(subErrMessage)

含义

B_COMPUTING_CanNotFindComputingGroup

没有匹配的计算分组

资源池计算资源未准备好

B_COMPUTING_PostPaidDisabled

后付费功能未开启, 请先订购后付费商品

未购买后付费实例时触发