sd 文生图-v3

文生图V3接口，支持controlnet、adetailer插件功能，请求体参数格式为Json数据结构、v2版本为string类型。

请求参数

Header 参数

X-Request-req-accessKeyId

string

接口认证ID

可选

示例值:

openapi-ab0ve5ma5y0w0000

X-Request-req-accessKeySecret

string

接口认证密钥

可选

示例值:

om6qr46e9pxq2z5goxp2xyj92ma10086

Body 参数application/json

prompt

string

正向提示词

可选

引导提示语

<= 2000 字符

negativePrompt

string

负向提示词

可选

反向提示语，即目标图同负向提示词相关度尽可能为0

iterationCount

integer

迭代次数

可选

模型重复执行次数，默认值：1

默认值:

singleBatchImageCount

integer

单次迭代图片生成数量

可选

单次迭代目标图片数量

默认值:

steps

integer

采样步数

必需

默认值:

seed

string

随机种子

必需

业务参数相同，随机种子不同则目标图不同，否则相同

默认值:

-1

subSeed

string

附加随机种子

可选

subSeedStrength

number

附加随机种子交换强度

可选

附加随机种子变换强度，取值越大结果越不可预料

>= 0<= 1

默认值:

initialNoiseHeight

integer

初始噪声高度

可选

初始噪声的高度，影响图片采样过程中初始噪声的shape，推荐业务方取默认值或忽略此参数，-1表示关闭此功能

>= 128<= 2048

默认值:

-1

initialNoiseWeight

integer

初始噪声宽度

可选

初始噪声的宽度，影响图片采样过程中初始噪声的shape，推荐业务方取默认值或忽略此参数，-1表示关闭此功能

>= 128<= 2048

restoreFaces

boolean

是否支持脸部修复

可选

是否支持脸部修复，若支持则默认采用的模型是CodeFormer，可在override_settings进行设置修改，即face_restoration_model属性

默认值:

false

enableHighDefinitionRepair

boolean

高清修复

可选

是否支持高清修复，注意：若开启高清修复重绘幅度参数设置无效

默认值:

false

tilling

boolean

是否支持图片平铺

可选

是否支持图片平铺，开启后生成类似地板花纹一样可连续的图片

默认值:

false

width

integer

目标图尺寸宽度

可选

>= 128<= 1024

默认值:

512

height

integer

目标图尺寸高度

可选

>= 128<= 1024

默认值:

512

promptGuidanceFactor

number

提示词引导因子

可选

建议取值范围为7~11

>= 1<= 30

默认值:

samplerName

string

采样器名称

可选

采样器名称，推荐业务方取默认值或忽略此参数，若取默认值则服务基于采样方式进行选择合理的采样器

默认值:

None

samplerIndex

string

采样算法

可选

采样方式，采样方式和采样器同时设置传入优先基于采样器参数，采样方式可取：Euler a, Euler, LMS, Heun , DPM2, DPM2 a, DPM++ 2S a, DPM++ 2M, DPM++ SDE, DPM fast, DPM adaptive, LMS Karras, DPM2 Karras, DPM2 a Karras, DPM++ 2S a Karras, DPM++ SDE Karras, DPM++ 2M Karras

默认值:

Euler a

deNoisingStrength

number

重绘幅度

可选

重绘幅度，文生图开启高清修复生效，否则参数无效。图生图、局部重绘参数有效

>= 0<= 1

styles

array[string]

可选

提示词风格模板，基于传入的风格名称将对应提示词模板与传入提示词合并

scriptName

string

脚本名

可选

scriptArgs

object

脚本参数

可选

callbackUrl

string

回调地址

必需

目标结果异步推送

firstPhaseWidth

integer

一阶段目标图片宽度

可选

开启高清修复功能此参数生效。若参数不为0，则文生图一阶段图片生成宽度为此参数值

>= 128<= 1024

默认值:

firstPhaseHeight

integer

一阶段目标图片高度

可选

开启高清修复功能此参数生效。若参数不为0，则文生图一阶段图片生成高度为此参数值

>= 128<= 1024

默认值:

highDefinitionRepairScale

number

高清修复倍数

可选

高清修复倍数，参数值精度为0.05，最终生成图片的尺寸为此参数乘以width、height

>= 1<= 4

highDefinitionRepairEnlarger

string

高清修复放大器

可选

高清修复放大器，取默认值None则表示暂不进行高清修复操作，可取值：None, Lanczos, Nearest, ESRGAN_4x, LDSR, R-ESRGAN 4x+, R-ESRGAN 4x+ Anime6B, ScuNET GAN, ScuNET PSNR, SwinIR_4x

默认值:

None

highDefinitionRepairPostSteps

integer

高清修复操作的迭代步数

可选

高清修复操作的迭代步数，若取值为0则底层采用steps参数作为高清修复得迭代步数

>= 0<= 50

默认值:

highDefinitionRepairImageWidth

integer

高清修复目标图宽度

可选

高清修复目标图宽度，若此参数和highDefinitionRepairImageHeight参数均为0，则highDefinitionRepairScale参数作为目标图图片尺寸决定因素，否则以此参数和highDefinitionRepairImageHeight参数为准。若此参数为0，参数highDefinitionRepairImageHeight不为0则目标图宽度等比缩放，高度以highDefinitionRepairImageHeight为准

>= 128<= 2048

默认值:

highDefinitionRepairImageHeight

integer

高清修复目标图高度

可选

高清修复目标图高度，若此参数和highDefinitionRepairImageWidth参数均为0，则highDefinitionRepairScale参数作为目标图图片尺寸决定因素，否则以此参数和highDefinitionRepairImageWidth参数为准。若此参数为0，参数highDefinitionRepairImageWidth不为0则目标图高度等比缩放，高度以highDefinitionRepairImageWidth为准

>= 128<= 2048

默认值:

highDefinitionRepairSamplerName

string

高清修复采样器名称

可选

高清修复采样器名称，若为None，则复用参数samplerName

highDefinitionRepairPrompt

string

高清修复正向提示词

可选

高清修复正向提示词，若参数为空则复用参数prompt

highDefinitionRepairNegativePrompt

string

高清修复负向提示词

可选

高清修复负向提示词，若参数为空则复用参数negativePrompt

saasDrawingExternalBaseParameterBO

object

各类脚本及设置参数

必需

baseModelCode

string

SD基础模型编码

必需

vaeName

string

VAE模型名称

可选

businessTaskId

string

业务方自定义任务ID

必需

targetImageFormat

string

输出图片格式

可选

输出图片格式，默认无需传参，输出图片格式jpg，可支持输入png

saasDrawingOverrideSettingParameterBO

object

覆盖设置参数

必需

saasDrawingADetailerPluginBO

object

ADetailer插件

可选

saasDrawingControlPluginBO

object

controlNet插件

可选

示例

{
    "prompt": "string",
    "negativePrompt": "string",
    "iterationCount": 1,
    "singleBatchImageCount": 1,
    "steps": 20,
    "seed": "-1",
    "subSeed": "string",
    "subSeedStrength": 0,
    "initialNoiseHeight": -1,
    "initialNoiseWeight": 128,
    "restoreFaces": false,
    "enableHighDefinitionRepair": false,
    "tilling": false,
    "width": 512,
    "height": 512,
    "promptGuidanceFactor": 7,
    "samplerName": "None",
    "samplerIndex": "Euler a",
    "deNoisingStrength": 0,
    "styles": [
        "string"
    ],
    "scriptName": "string",
    "scriptArgs": {},
    "callbackUrl": "string",
    "firstPhaseWidth": 0,
    "firstPhaseHeight": 0,
    "highDefinitionRepairScale": 1,
    "highDefinitionRepairEnlarger": "None",
    "highDefinitionRepairPostSteps": 0,
    "highDefinitionRepairImageWidth": 0,
    "highDefinitionRepairImageHeight": 0,
    "highDefinitionRepairSamplerName": "string",
    "highDefinitionRepairPrompt": "string",
    "highDefinitionRepairNegativePrompt": "string",
    "saasDrawingExternalBaseParameterBO": {
        "baseModelCode": "string",
        "vaeName": "string",
        "businessTaskId": "string",
        "targetImageFormat": "string",
        "saasDrawingOverrideSettingParameterBO": {
            "clipSkipLayers": 1
        },
        "saasDrawingADetailerPluginBO": {
            "saasDrawingADetailerPluginParameterBOS": [
                {
                    "enablePlugin": false,
                    "modelName": "string",
                    "prompt": "string",
                    "negativePrompt": "string",
                    "confidenceThreshold": 0.3,
                    "maskAreaMinRatio": 0,
                    "maskAreaMaxRatio": 0,
                    "imageExpansionPixel": 4,
                    "maskOffsetOfXAxis": 0,
                    "maskOffsetOfYAxis": 0,
                    "maskMergeMode": "None",
                    "maskFuzzyBoundaryPixel": 4,
                    "reductionNoiseStrength": 0.4,
                    "repairSourceImageMask": false,
                    "repairSourceImageMaskAreaPixel": 32,
                    "useRepairedImageScaleSwitch": false,
                    "repairedImageWidth": 512,
                    "repairedImageHeight": 512,
                    "usePluginGenerateStep": true,
                    "generateStep": 28,
                    "usePluginPromptGuidanceFactor": true,
                    "promptGuidanceFactor": 7,
                    "usePluginSampler": true,
                    "sampler": "string",
                    "usePluginNoiseMultiplier": true,
                    "noiseMultiplier": 1,
                    "userPluginClipSkipLayers": true,
                    "clipSkipLayers": 1,
                    "enablePluginRestoreFace": true,
                    "controlNetModel": "string",
                    "controlNetModule": "string",
                    "controlNetWeight": 1,
                    "startGuidanceStep": 0,
                    "endGuidanceStep": 1
                }
            ]
        },
        "saasDrawingControlPluginBO": {
            "saasDrawingControlPluginParameterBOS": [
                {
                    "controlImageUrl": "string",
                    "enabled": false,
                    "module": "string",
                    "model": "string",
                    "weight": 0.7,
                    "imageResize": "string",
                    "reduceVideoMemoryUsage": true,
                    "processorReSize": 512,
                    "thresholdA": 0,
                    "thresholdB": 0,
                    "guidanceStart": 0,
                    "guidanceEnd": 1,
                    "pixelPerfect": true,
                    "controlMode": "string",
                    "inputMode": "string",
                    "batchImages": "string",
                    "loopback": true
                }
            ]
        }
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zhiqite.com/AIGCImgOpenServ/saas/sd/v3/text2Image' \
--header 'X-Request-req-accessKeyId: openapi-ab0ve5ma5y0w0000' \
--header 'X-Request-req-accessKeySecret: om6qr46e9pxq2z5goxp2xyj92ma10086' \
--header 'Content-Type: application/json' \
--data-raw '{
    "prompt": "string",
    "negativePrompt": "string",
    "iterationCount": 1,
    "singleBatchImageCount": 1,
    "steps": 20,
    "seed": "-1",
    "subSeed": "string",
    "subSeedStrength": 0,
    "initialNoiseHeight": -1,
    "initialNoiseWeight": 128,
    "restoreFaces": false,
    "enableHighDefinitionRepair": false,
    "tilling": false,
    "width": 512,
    "height": 512,
    "promptGuidanceFactor": 7,
    "samplerName": "None",
    "samplerIndex": "Euler a",
    "deNoisingStrength": 0,
    "styles": [
        "string"
    ],
    "scriptName": "string",
    "scriptArgs": {},
    "callbackUrl": "string",
    "firstPhaseWidth": 0,
    "firstPhaseHeight": 0,
    "highDefinitionRepairScale": 1,
    "highDefinitionRepairEnlarger": "None",
    "highDefinitionRepairPostSteps": 0,
    "highDefinitionRepairImageWidth": 0,
    "highDefinitionRepairImageHeight": 0,
    "highDefinitionRepairSamplerName": "string",
    "highDefinitionRepairPrompt": "string",
    "highDefinitionRepairNegativePrompt": "string",
    "saasDrawingExternalBaseParameterBO": {
        "baseModelCode": "string",
        "vaeName": "string",
        "businessTaskId": "string",
        "targetImageFormat": "string",
        "saasDrawingOverrideSettingParameterBO": {
            "clipSkipLayers": 1
        },
        "saasDrawingADetailerPluginBO": {
            "saasDrawingADetailerPluginParameterBOS": [
                {
                    "enablePlugin": false,
                    "modelName": "string",
                    "prompt": "string",
                    "negativePrompt": "string",
                    "confidenceThreshold": 0.3,
                    "maskAreaMinRatio": 0,
                    "maskAreaMaxRatio": 0,
                    "imageExpansionPixel": 4,
                    "maskOffsetOfXAxis": 0,
                    "maskOffsetOfYAxis": 0,
                    "maskMergeMode": "None",
                    "maskFuzzyBoundaryPixel": 4,
                    "reductionNoiseStrength": 0.4,
                    "repairSourceImageMask": false,
                    "repairSourceImageMaskAreaPixel": 32,
                    "useRepairedImageScaleSwitch": false,
                    "repairedImageWidth": 512,
                    "repairedImageHeight": 512,
                    "usePluginGenerateStep": true,
                    "generateStep": 28,
                    "usePluginPromptGuidanceFactor": true,
                    "promptGuidanceFactor": 7,
                    "usePluginSampler": true,
                    "sampler": "string",
                    "usePluginNoiseMultiplier": true,
                    "noiseMultiplier": 1,
                    "userPluginClipSkipLayers": true,
                    "clipSkipLayers": 1,
                    "enablePluginRestoreFace": true,
                    "controlNetModel": "string",
                    "controlNetModule": "string",
                    "controlNetWeight": 1,
                    "startGuidanceStep": 0,
                    "endGuidanceStep": 1
                }
            ]
        },
        "saasDrawingControlPluginBO": {
            "saasDrawingControlPluginParameterBOS": [
                {
                    "controlImageUrl": "string",
                    "enabled": false,
                    "module": "string",
                    "model": "string",
                    "weight": 0.7,
                    "imageResize": "string",
                    "reduceVideoMemoryUsage": true,
                    "processorReSize": 512,
                    "thresholdA": 0,
                    "thresholdB": 0,
                    "guidanceStart": 0,
                    "guidanceEnd": 1,
                    "pixelPerfect": true,
                    "controlMode": "string",
                    "inputMode": "string",
                    "batchImages": "string",
                    "loopback": true
                }
            ]
        }
    }
}'

application/json

Body

code

string

响应码

必需

msg

string

响应信息

必需

data

object

可选

saasTaskId

string

任务ID

可选

示例

{
    "code": "200",
    "msg": "success",
    "data": {
        "saasTaskId": "pro-81345367887345"
    }
}

请求参数

示例代码

返回响应