Start ComfyUI Task 1 - Basic

Request

Authorization

Header Params

Host

string

required

Example:

www.runninghub.ai

Body Params application/json

apiKey

string

required

Example:

workflowId

string

required

Example:

1904136902449209346

addMetadata

boolean

optional

Example

{
    "apiKey": "{{apiKey}}",
    "workflowId": "1904136902449209346",
    "addMetadata": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://www.runninghub.ai/task/openapi/create' \
--header 'Host: www.runninghub.ai' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey": "Please enter your own apiKey and keep it safe.",
    "workflowId": "1904136902449209346",
    "addMetadata": true
}'

Responses

🟢200成功

application/json

Body

code

integer

optional

返回标记：成功标记=0，非0失败，或者是功能码

Example:

0

msg

string

optional

返回信息

Example:

success

data

object (TaskCreateResponse)

optional

数据

netWssUrl

string

optional

Wss服务地址

taskId

integer <int64>

optional

任务Id

clientId

string

optional

客户端ID，当客户端首次接收clientId时，需要保存到本地，以便页面刷新重连或者二次运行任务传参使用

taskStatus

string

optional

任务状态: CREATE, SUCCESS, FAILED, RUNNING, QUEUED;

promptTips

string

optional

工作流验证结果提示,当不为空是UI需要展示节点错误信息

Example

{
    "code": 0,
    "msg": "success",
    "data": {
        "netWssUrl": "wss://www.runninghub.cn:443/ws/c_instance?c_host=10.129.240.44&c_port=80&clientId=e825290b08ca2015b8f62f0bbdb5f5f6&workflowId=1904136902449209346&Rh-Comfy-Auth=eyJ1c2VySWQiOiJkZTBkYjZmMjU2NGM4Njk3YjA3ZGY1NWE3N2YwN2JlOSIsInNpZ25FeHBpcmUiOjE3NDM1NjQ2NTQ1NTIsInRzIjoxNzQyOTU5ODU0NTUyLCJzaWduIjoiNjVkMTVhYjA3Njg2MjJlOGM1YzJkNTc2MzQwOWFmYzkifQ%3D%3D&target=https://hbxy.runninghub.cn:11143",
        "taskId": "1904737800233889793",
        "clientId": "e825290b08ca2015b8f62f0bbdb5f5f6",
        "taskStatus": "RUNNING",
        "promptTips": "{\"result\": true, \"error\": null, \"outputs_to_execute\": [\"9\"], \"node_errors\": {}}"
    }
}