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

工作流任务提交后，可以通过这个结果用于跟踪任务的进度或者获取最终任务结果

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

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

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json

taskId

string

绘画任务ID

必需

提交工作流绘画任务接口后返回的值

waitUtilEnd

boolean

是否等待任务完成

可选

传true的情况下，获取任务结果会等工作流执行完毕后才会返回结果，不需要进行轮询,可以更实时的获取结果，但是需要注意请求可能会因为网络等问题中断，因此调用者需要做好重试处理

默认值:

false

示例

{
  "taskId": "6525fdbcd57f45a2bd873799cf8b6e8b"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

data

object

必需

state

string

任务状态

必需

任务状态共有4种：

in_queue任务当前已经进入队列，等待执行中

running任务当前正在执行中，请继续轮询此接口获取最新状态

success任务执行结束，并且结果为成功，可以获取任务结果

fail 任务执行结束，但是结果为失败，可以获取失败原因

failReason

string

失败消息

可选

仅在任务失败的时候有返回

progress

number

任务进度

必需

取值范围0~1.0

coverImageUrl

string

本次生成的封面图

可选

files

array [object {2}]

本次生成的图片列表

可选

仅在state为success才会返回。不管是单图还是多图，都会单独在这个数组里面返回每一个图片

code

integer

API统一响应码

必需

错误码请参考此文档

msg

string

错误消息

必需

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

success

boolean

是否处理成功

必需

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

示例

{
  "data": {
    "taskId": "6525fdbcd57f45a2bd873799cf8b6e8b",
    "state": "success",
    "progress": 1,
    "coverImageUrl": "https://imgsource.huashi6.com/images/ai/flow/2024/6/18/14_10_32_3912888.png?e=1718691915&token=qFZErZx7WS1v5B4rgQE2KLMHlYHVNaCuXeaA9OLD:SToDZvaIoeVgMWbtt8B8b82LXqM=",
    "files": [
      {
        "audit": 1,
        "url": "https://imgsource.huashi6.com/temp/17_32_6_7359903.png?e=1717755573&token=qFZErZx7WS1v5B4rgQE2KLMHlYHVNaCuXeaA9OLD:nQJcIgNJmko8a4J0aoN2Uu0jS38="
      }
    ]
  },
  "code": 0,
  "success": true
}