文生图

Action GenerateTxt2Img

简介

⚠️

该接口已过时，不再维护。

此接口用于使用文字生成图片

请求

参数名	类型	描述信息	必填
Action	`String`	对应的 API 指令名称，当前 API 为 `GenerateTxt2Img`	✓
PublicKey	`String`	用户公钥，可从用户中心 (opens in a new tab) 获取	✓
Signature	`String`	根据公钥及 API 指令生成的用户签名，参见签名算法	✓
request_uuid	`String`	请求uuid，采用uuid生成方式随机生成
ModelType	`String`	模型类型，参考值：`combined_model`、`custom_model`。使用PICPIK提供的官方模型需填写`combined_model`，使用自训练或上传的模型需填写`custom_model`	✓
MainModelId	`Int`	主模型ID若ModelType为`combined_model`，则填写`SystemPreInstallModels`的Id，否则填写则填写`SelfMainModels`的Id	✓
SubModelIds	`[]int`	子模型列表，若ModelType为`combined_model`则不填写
SubModelParams	`[]SubModelParam`	子模型参数，若使用，SubModelIds，则可通过此参数控制子模型的权重
BatchSize	`Int`	批量出图大小1~16	✓
Steps	`Int`	迭代步数1~150	✓
CfgScale	`Float`	提示词指导程度0~30	✓
Seed	`Int`	随机数种子	✓
Sampler	`String`	采样器，参考采样器列表	✓
Width	`Int`	图片生成宽度，最大值: 1440，最小值: 16	✓
Height	`Int`	图片生成高度，最大值: 1440，最小值: 16	✓
ClipSkip	`Int`	ClipSkip	✓
TranslatePrompt	`Bool`	是否将提示词翻译成英文	✓
PositivePrompts	`[]String`	正面提示词
NegativePrompts	`[]String`	反面提示词
EnableControlNet	`Bool`	是否开启controlNet
ControlNetParams	`[]ControlNetParam`	ControlNet参数列表(最多三个)
UseCustomMainModelVae	`Bool`	是否使用主模型VAE，true为使用主模型自带VAE，默认false

ControlNetParam

参数名	类型	描述信息
ControlNetImg	`String`	ControlNet图片base64
ControlPreSetId	`String`	ControlNet预设参数Id，0:自定义，1:简笔涂鸦，2:人物姿势，3:动漫线稿，4: 空间线稿
ControlWeight	`Float`	ControlNet权重 0~2
ModelId	`Int`	ControlNet模型Id
PreProcessorId	`Int`	ControlNet预处理器Id
StartingControlStep	`Float`	ControlNet开始介入步数
EndingControlStep	`Float`	ControlNet结束介入步数
ControlMode	`String`	控制模式，参考值: Balanced、MyPromptIsMoreImportant、ControlNetIsMoreImportant
ResizeMode	`String`	缩放模式，参考值：JustResize、CropAndResize、ResizeAndFill
PreProcessorResolution	`Int`	PreProcessorResolution
Param1Value	`Float`	参数1
Param2Value	`Float`	参数2

注： ControlPreSetId 若填写非0，则只需填写ControlNetImg与ControlWeight参数即可，反之则需要填写所有参数。参数参见获取ControlNet模型列表。

SubModelParam

参数名	类型	描述信息	必填
SubModelId	`Int`	子模型id
ControlWeight	`Float`	子模型控制权重(Lora权重)

请求示例

{
	"Action": "GenerateTxt2Img",
	"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
	"Signature": "10e99193615e2c363f15f7339b3dac0c91a9272a",
	"request_uuid": "fc30beb9-89e3-4f38-9c90-82201fe91d32",
	"ModelType": "combined_model",
	"MainModelId": 1,
	"BatchSize": 1,
	"Steps": 20,
	"CfgScale": 7.5,
	"Seed": -1,
	"Sampler": "Euler",
	"ClipSkip": 1,
	"Width": 512,
	"Height": 512,
	"PositivePrompts":[
        "a apple"
    ],
    "NegativePrompts":[
 
    ],
	"TranslatePrompt": true
}

带ControlNet的请求示例

{
    "Action":"GenerateTxt2Img",
    "PublicKey":"ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "Signature":"10e99193615e2c363f15f7339b3dac0c91a9272a",
    "request_uuid":"fc30beb9-89e3-4f38-9c90-82201fe91d32",
    "ModelType":"combined_model",
    "MainModelId":1,
    "BatchSize":1,
    "Steps":20,
    "CfgScale":7.5,
    "Seed":-1,
    "Sampler":"Euler",
    "ClipSkip":1,
    "Width":512,
    "Height":512,
    "PositivePrompts":[
        "a apple"
    ],
    "NegativePrompts":[
 
    ],
    "TranslatePrompt":true,
    "EnableControlNet":true,
    "ControlNetParams":[
        {
            //使用预设参数的ControlNet
            "ControlPreSetId":2,
            "ControlWeight":1.5,
            "ControlNetImg":"data:image/jpeg;base64,xxx"
        },
        {
            //使用自设参数的ControlNet ControlPreSetId为0
            "ControlMode":"Balanced",
            "ControlNetImg":"data:image/jpeg;base64,xxx",
            "ControlPreSetId":0,
            "ControlWeight":1,
            "EndingControlStep":1,
            "ModelId":4,
            "PreProcessorId":5,
            "PreProcessorResolution":512,
            "ResizeMode":"JustResize",
            "StartingControlStep":0,
            "Param1Value":10,
            "Param2Value":30
        }
    ]
}

响应

参数名	类型	描述信息	必填
RetCode	`Int`	返回状态码，为 0 则为成功返回，非 0 为失败	✓
Action	`String`	操作指令名称	✓
Message	`String`	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息
TaskUID	`String`	任务UID，用于查询任务详情与获取结果	✓

响应示例

{
    "Action":"",
    "RetCode":0,
    "Message":"",
    "TaskUID":"cjr997tleg738lelk3n0"
}

支持的采样器列表

采样器名称
Euler a
Euler
LMS
Heun
DPM2
DPM2 a
DPM++ 2S a
DPM++ 2M
DPM++ SDE
DPM++ 2M SDE
DPM fast
DPM adaptive
LMS Karras
DPM2 Karras
DPM2 a Karras
DPM++ 2S a Karras
DPM++ 2M Karras
DPM++ SDE Karras
DPM++ 2M SDE Karras
DDIM
PLMS
UniPC

批量查询生图任务详情图生图