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

通过该接口可获取工作流任务所需的参数以及参数要求，之后使用参数提交工作流任务

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

您也可以使用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可以简化小工具的字段传递，具体工作流的预设列表请联系您的商务对接人获取

示例

{
    "workflowId": 876606950123,
    "versionId": 6
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

data

object

必需

consume

integer

需消耗的积分

必需

name

string

工作流名称

必需

currentVersionId

string

版本号id

必需

fields

array [object {8}]

工作流相关参数详情

必需

code

integer

API统一响应码

必需

错误码请参考此文档

msg

string

错误消息

必需

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

success

boolean

是否处理成功

必需

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

示例

{
    "data": {
        "consume": 10,
        "name": "涂鸦生成作品",
        "currentVersionId": "6",
        "fields": [
            {
                "nodeId": 42,
                "paramName": "image",
                "inputName": "上传涂鸦",
                "required": true,
                "type": 3,
                "tips": "建议关注涂鸦线条和色块使用，它们决定了画面的丰富程度",
                "rule": {
                    "picFormats": [
                        "gif",
                        "jpeg",
                        "webp"
                    ]
                }
            },
            {
                "nodeId": 7,
                "paramName": "positive",
                "inputName": "描述涂鸦画面",
                "required": true,
                "type": 1,
                "tips": "",
                "rule": {
                    "multiline": true,
                    "maxCount": 500
                }
            },
            {
                "nodeId": 8,
                "paramName": "empty_latent_width",
                "inputName": "生成图片宽度",
                "required": true,
                "type": 2,
                "tips": "",
                "rule": {
                    "isDecimal": false,
                    "maxValue": 1024,
                    "minValue": 512
                }
            },
            {
                "nodeId": 9,
                "paramName": "empty_latent_height",
                "inputName": "生成图片高度",
                "required": true,
                "type": 2,
                "tips": "",
                "rule": {
                    "isDecimal": false,
                    "maxValue": 1024,
                    "minValue": 512
                }
            }
        ]
    },
    "code": 0,
    "success": true
}