接口能力

通过 ControlNet 生成形状可控的图像内容，支持四种控制方式：

depth：深度图

canny：轮廓图

pose：人体姿势

mlsd：线描图

本接口为异步接口，需要把返回结果中的 uid 做为参数，通过 「查询接口-查询任务结果」（/engine/status）接口轮询获取结果

提交 ControlNet 任务接口支持积分模式按次调用；
包月用户和部署用户不限次调用(需要提前联系客服部署模型)

积分扣除规则

一次调用消耗 5 积分（对于 512×704 及以下分辨率）

注：
1.
由于敏感图等问题提交任务成功但生成失败的，将退还积分
2.
标准分辨率下图片尺寸是 512×704，面积低于该尺寸维持原价，面积大于该尺寸按比例增加消耗的积分
如，(1024×1024)/(512×704)=2.9，则生成 1024×1024 的图片会需要 5×2.9=14.5 积分
3.
一般来说，图片生成效果在标准分辨率下效果最佳（生成 512×512 的图，不要轻易直接使用生成1024×1024的图，一般情况下效果不好）；如需更高清的图片，建议先生成 512×512 标准分辨率图片，再使用图像超分辨率功能进行高清化
4.
调用画宇宙引擎前，如果涉及中文文本输入，需要先调用提示词（prompt）预处理接口（因为提交任务接口中的prompt参数仅支持英文输入），以进行文本翻译并预先屏蔽掉敏感的提示词
5.
推理一张512 × 512的图，约耗时9~12s（不算排队和网络传输）

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization

string

必需

此值可以在开放平台(https://open.creator.nolibox.com) - 应用列表 - 操作中的"TOKEN"中获取。计算方式："Basic " + Base64.encode(App Key:App Secret)

示例值:

Basic xxxxxxxxxx

Body 参数application/json

types

array[string]

生成模型

必需

枚举值:

depthcannyposemlsd

url

string

源图地址

必需

当任务为 img2img.sd 时，此参数必填。宽高不能超过 1024

hint_url

string

mask 图片地址

可选

参考图的 url

hint_starts

object

开始参考的时刻

可选

depth

number

可选

canny

number

可选

pose

number

可选

mlsd

number

可选

prompt

string

提示词

必需

内容必须为英文，中文内容需要先调用 提示词预处理接口翻译为英文

fidelity

number

相似度

可选

当任务类型为 img2img时，此字段有意义

>= 0<= 1

默认值:

0.2

use_img2img

boolean

是否使用垫图生成

可选

bypass_annotator

boolean

是否不使用内置的标注器

可选

默认值:

false

guess_mode

boolean

启用猜测模式

可选

不推荐

默认值:

false

max_wh

integer

限制最大宽高

可选

use_circular

boolean

是否启用循环纹样

可选

seed

integer

随机种子

可选

取值范围：-1~2^32-1
-1 代指不指定 seed，此时我们算法内部会随机生成一个 seed

>= -1<= 429496728

默认值:

-1

variation_seed

integer

生成相似的种子

可选

variation_strength

number

生成相似的强度

可选

variations

array [object {2}]

生成相似的详细配置

可选

seed

integer

可选

strength

number

可选

num_steps

integer

采样步数

可选

默认值是 20 取值范围：5~100

>= 5<= 100

默认值:

guidance_scale

number

扣题程度

可选

默认值是 7.5

默认值:

7.5

negative_prompt

string

负面词

可选

默认值是空字符串
空字符串意味着不使用负面词

is_anime

boolean

是否使用动漫模型

可选

sampler

string

采样器

可选

depth_params

object

可选

control_strength

number

可选

detect_resolution

integer

可选

canny_params

object

可选

control_strength

number

可选

detect_resolution

integer

可选

low_threshold

number

可选

high_threshold

number

可选

pose_params

object

可选

control_strength

number

可选

detect_resolution

integer

可选

mlsd_params

object

可选

control_strength

number

可选

detect_resolution

integer

可选

value_threshold

number

可选

distance_threshold

number

可选

notify_url

string

回调通知地址

可选

示例

{
    "types": [
        "depth"
    ],
    "url": "string",
    "hint_url": "string",
    "hint_starts": {
        "depth": 0,
        "canny": 0,
        "pose": 0,
        "mlsd": 0
    },
    "prompt": "string",
    "fidelity": 0.2,
    "use_img2img": true,
    "bypass_annotator": "false",
    "guess_mode": "false",
    "max_wh": 0,
    "use_circular": true,
    "seed": -1,
    "variation_seed": 0,
    "variation_strength": 0,
    "variations": [
        {
            "seed": 0,
            "strength": 0
        }
    ],
    "num_steps": 20,
    "guidance_scale": 7.5,
    "negative_prompt": "string",
    "is_anime": true,
    "sampler": "string",
    "depth_params": {
        "control_strength": 0,
        "detect_resolution": 0
    },
    "canny_params": {
        "control_strength": 0,
        "detect_resolution": 0,
        "low_threshold": 0,
        "high_threshold": 0
    },
    "pose_params": {
        "control_strength": 0,
        "detect_resolution": 0
    },
    "mlsd_params": {
        "control_strength": 0,
        "detect_resolution": 0,
        "value_threshold": 0,
        "distance_threshold": 0
    },
    "notify_url": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

提交 ControlNet 任务

接口能力#

积分扣除规则#

请求参数

示例代码

返回响应

接口能力

积分扣除规则