关于
欢迎使用 RunningHub API,轻松调用 RunningHub 云端的 ComfyUI 工作流
开始使用 #
注册用户 #
注册 RunningHub 账号并充值钱包后,即可开始使用 AI 应用 API 和 ComfyUI 工作流 API。 请注意:若您使用 消费级-会员 API Key,需拥有 基础版及以上会员 才能调用上述接口。 使用 企业级-共享 或 企业级-独占 API Key 的用户不受此限制。
提交请求 #
提交 API 请求。RunningHub API 已为您处理 API Key,您只需提交请求即可
请求示例 #
curl
请求参数说明 #
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
nodeInfoList | List | 必填 | 节点参数映射列表,用于动态修改工作流参数 |
instanceType | String | 可选 | 指定运行实例的类型 default (24G显存), plus (48G显存) |
usePersonalQueue | Boolean | 可选 | 是否使用个人独占队列 |
retainSeconds | Integer | 可选 | 实例保留时长(秒)。仅企业共享 API Key 生效;任务成功结束后会在指定时长内优先复用同用户同工作流实例,减少冷启动与排队。该保留时段会产生额外费用,按实际保留时长计费。可选范围:10~180 秒。 |
webhookUrl | String | 可选 | Webhook 回调地址,任务完成时会向该地址发送 POST 请求 |
响应示例 #
json
{
"taskId": "2013508786110730241",
"status": "RUNNING",
"errorCode": "",
"errorMessage": "",
"results": null,
"clientId": "f828b9af25161bc066ef152db7b29ccc",
"promptTips": "{\"result\": true, \"error\": null, \"outputs_to_execute\": [\"4\"], \"node_errors\": {}}"
}响应字段说明 #
| 参数 | 类型 | 说明 |
|---|---|---|
taskId | String | 任务ID,用于后续查询任务状态 |
status | String | 当前任务状态,常见状态:QUEUED (排队中), RUNNING (运行中), SUCCESS (成功), FAILED (失败) |
errorCode | String | 错误码,仅在失败时返回 |
errorMessage | String | 错误具体信息 |
results | List | 生成结果(提交时为 null) |
├ url | String | 重要提醒:该链接有效期仅为 24 小时。任务生成结束后,请务必在此时间窗口内将视频文件下载或转存至您的服务器。逾期后链接将永久失效且无法恢复。 |
├ nodeId | String | 生成该结果的工作流节点 ID |
├ outputType | String | 文件扩展名 (如 png, mp4, txt) |
└ text | String | 如果输出是纯文本,内容将显示在此字段 |
clientId | String | 客户端会话ID,用于标识本次连接 |
promptTips | String (JSON) | ComfyUI 后端的校验信息,包含需执行的节点ID等调试信息 |
查询结果与 Webhook #
如果在提交时添加了 "webhookUrl": "https://example.com/webhook" 请求体参数,RunningHub 会在任务完成时向您的URL发送POST请求
请求示例 #
curl
响应示例 #
json
{
"taskId": "2013508786110730241",
"status": "SUCCESS",
"errorCode": "",
"errorMessage": "",
"failedReason": {},
"usage": {
"consumeMoney": null,
"consumeCoins": null,
"taskCostTime": "0",
"thirdPartyConsumeMoney": null
},
"results": [
{
"url": "https://rh-images-1252422369.cos.ap-beijing.myqcloud.com/b04e28cad0ee39193921a30a2eb4dc00/output/ComfyUI_00001_plhjr_1768892915.png",
"nodeId": "2",
"outputType": "png",
"text": null
}
],
"clientId": "",
"promptTips": ""
}响应字段说明 #
| 参数 | 类型 | 说明 |
|---|---|---|
taskId | String | 任务 ID |
status | String | 任务最终状态,SUCCESS 表示生成成功 |
results | List | 生成结果列表,包含图片、视频或文本等输出 |
├ url | String | 重要提醒:该链接有效期仅为 24 小时。任务生成结束后,请务必在此时间窗口内将视频文件下载或转存至您的服务器。逾期后链接将永久失效且无法恢复。 |
├ nodeId | String | 生成该结果的工作流节点 ID |
├ outputType | String | 文件扩展名 (如 png, mp4, txt) |
└ text | String | 如果输出是纯文本,内容将显示在此字段 |
errorCode | String | 错误码 (如有) |
errorMessage | String | 错误信息 (如有) |
failedReason | Object | ComfyUI 相关的失败原因 |
usage | Object | 任务消耗信息 |
├ thirdPartyConsumeMoney | String | 三方API消费金额 |
├ consumeMoney | String | 运行时长消耗金额 |
├ consumeCoins | String | 运行消耗的RH币 |
└ taskCostTime | String | 运行耗时(ComfyUI 工作流运行时长) |
Webhook 回调示例 #
如果在提交时添加了 "webhookUrl": "https://example.com/webhook" 请求体参数,RunningHub 会在任务完成时向您的 URL 发送 POST 请求:
json
{
"event": "TASK_END",
"eventData": {
"clientId": "",
"errorCode": "1501",
"errorMessage": "Content verification failed, 改提示词或图片",
"failedReason": {},
"usage": {
"consumeMoney": null,
"consumeCoins": null,
"taskCostTime": "0",
"thirdPartyConsumeMoney": null
},
"promptTips": "",
"results": null,
"status": "FAILED",
"taskId": "2015810049043947521"
},
"taskId": "2015810049043947521"
}Webhook 字段说明 #
| 参数 | 类型 | 说明 |
|---|---|---|
event | String | 事件类型,如 TASK_END |
eventData | Object | 事件数据对象:与查询结果响应字段相同 |
taskId | String | 任务 ID(同 eventData.taskId) |
文件上传 #
资源文件(如 imageUrls)参数支持传入文件 URL 或 Base64 Data URI。
Base64 data URI #
以 Base64 格式嵌入图片:
json
{
"images": [
"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
]
}RH 上传接口 #
上传本地文件以获取一个 URL。
Endpoint: https://runninghub.cn/openapi/v2/media/upload/binary
请求
curl
curl --location --request POST 'https://runninghub.cn/openapi/v2/media/upload/binary' \
--header 'Authorization: Bearer [Your API KEY]' \
--form 'file=@/path/to/image.png'响应
json
{
"code": 0,
"message": "success",
"data": {
"type": "image",
"download_url": "xxxx.png",
"fileName": "openapi/xxxx.png",
"size": "3490"
}
}备注: 上传后获得的链接有效期为 1 天,超期将无法通过 URL 直接访问。