2.提交工作流(小工具)任务执行

POST

https://ai.huashi6.com/aiapi/workflow/run

最后修改时间：2025-02-06 06:51:48

该接口用于提交工作流任务，所需的参数详情可通过工作流详情接口获取，此接口为异步提交任务接口，并不直接返回最终的结果，请调用获取工作流任务详情接口获取进度或者结果

关于小工具（工作流）接口调用的具体使用方式和流程，请参考此文档

您也可以使用API调试工具生成请求参数和提交任务，调试工具地址:https://open.czhanai.com/debug/api.html

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

workflowId

integer

工作流ID

必需

versionId

integer

版本号ID

可选

不传版本号则使用最新版本（如无特殊需求请使用最新版本以使用最新的功能和效果）

presetId

integer

预设模板id

可选

此次任务所用到的预设模板ID。请注意，预设模板会覆盖部分字段的设置

exclusiveMode

boolean

是否开启独占模式

可选

关于独占模式的解释与使用场景请参考此文档

默认值:

false

inputs

array [object {5}]

工作流相关参数

必需

nodeId

integer

节点ID

必需

paramName

string

参数名

必需

value

string

参数值

必需

options

object

选项

可选

code

string

字段唯一编码

可选

传了该字段则无需传nodeId和paramName

callback

string

结果回调地址

可选

支持IP等URL请参考回调使用指南

示例值:

https://exmple.com/callback

nonce

string

自定义请求回调标识

可选

任意长度不超过32的字符串，具体请参考回调使用指南

<= 32 字符

示例

{
  "workflowId": 876606950123,
  "versionId": 6,
  "inputs": [
    {
      "nodeId": 42,
      "paramName": "image",
      "value": "https://plc.jj20.com/up/allimg/mx10/010220233P1/200102233P1-0.jpeg"
    },
    {
      "nodeId": 7,
      "paramName": "positive",
      "value": "a flower"
    },
    {
      "nodeId": 8,
      "paramName": "empty_latent_width",
      "value": "512"
    },
    {
      "nodeId": 9,
      "paramName": "empty_latent_height",
      "value": "512"
    }
  ],
  "exclusiveMode": true,
  "callback": "https://exmple.com/callback",
  "nonce": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ai.huashi6.com/aiapi/workflow/run' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflowId": 876606950123,
    "versionId": 6,
    "inputs":[
		{
			"nodeId": 42,
			"paramName": "image",
			"value": "https://plc.jj20.com/up/allimg/mx10/010220233P1/200102233P1-0.jpeg"
		},
        {
			"nodeId": 7,
			"paramName": "positive",
			"value": "a flower"
		},
        {
			"nodeId": 8,
			"paramName": "empty_latent_width",
			"value": "512"
		},
        {
			"nodeId": 9,
			"paramName": "empty_latent_height",
			"value": "512"
		}
    ],
	"exclusiveMode": true,
    "callback": "https://exmple.com/callback",
    "nonce": "string"
}'

返回响应

🟢200成功

application/json

Body

data

object

必需

taskId

string

绘画任务ID

必需

可以用于工作流绘画详情接口查询进度或者获取结果
请妥善记录保管此值，如果遇到问题需要进行调试排查请提供具体任务的此字段给我们

used

integer

本次扣减积分

必需

balance

integer

账户当前余额

必需

taskLimit

integer

任务限制数

必需

并发任务数

code

integer

API统一响应码

必需

错误码请参考此文档

msg

string

错误消息

必需

如果本次接口请求错误，则会返回对应的错误描述

success

boolean

是否处理成功

必需

简易字段用于区分本次请求接口是否处理成功

示例

{
  "data": {
    "taskId": "6525fdbcd57f45a2bd873799cf8b6e8b",
    "used": 10,
    "balance": 990,
    "taskLimit": 1
  },
  "code": 0,
  "success": true
}

修改于 2025-02-06 06:51:48

1.获取工作流(小工具)字段详情

3.获取工作流(小工具)任务进度或结果