API参考
获取ControlNet和预处理器

查询ControlNet模型与预处理器列表

Action ListControlNets

简介

此接口用于查询ControlNet模型与预处理器列表,其常用组合与用途如下:


ControlNet NameControlNet ModelCodePreProcessor NamePreProcessor ModelCode效果
Consistent Faceip-adapter-faceid-plusv2_sd15生图时应用参考图中的人脸。
Contents Migrate (Normal)ip-adapter_sd15生图时应用参考图的风格。
Depthcontrol_v11f1p_sd15_depthDepth (LeRes)depth_leres根据参考图的深度信息生成图片。
Depthcontrol_v11f1p_sd15_depthDepth (MiDas)depth同上
Depthcontrol_v11f1p_sd15_depthDepth (ZoE)depth_zoe同上
Hard Edgecontrol_v11p_sd15_cannyHard Edgecanny根据参考图中的线条信息生成图片。
Inpaintcontrol_v11p_sd15_inpaint在参考图标记的区域内生成内容。
Insruct Pix2Pixcontrol_v11e_sd15_ip2p利用提示词编辑图片。
Lineartcontrol_v11p_sd15_lineartLineartlineart类似“Hard Edge”模型,但曲线更柔和且生成结果更多样。
Lineartcontrol_v11p_sd15_lineartLineart (Standard)lineart_standard同上
Lineart Animiecontrol_v11p_sd15s2_lineart_animeLineart (Anime + Denoise)lineart_anime_denoise类似“Hard Edge”模型,但曲线更柔和且生成结果更多样(为动漫风格优化)。
Lineart Animiecontrol_v11p_sd15s2_lineart_animeLineart (Anime)lineart_anime同上
Normal Mapcontrol_v11p_sd15_normalbaeNormal Map (Bae)normal_bae类似“Depth"”模型,但基于法线贴图。
Posecontrol_v11p_sd15_openposePose (Full)openpose_full根据参考图中人物的姿势生成图片。
Recolorioclab_sd15_recolorRecolor (Intensity)recolor_intensity根据参考图中的色彩强度或亮度信息重新上色图片。
Recolorioclab_sd15_recolorRecolor (Luminance)recolor_luminance同上
Scribblecontrol_v11p_sd15_scribbleScribble (Edge)scribble_xdog类似“Hard Edge”模型,但更粗略且生成结果更多样。
Scribblecontrol_v11p_sd15_scribbleScribble (HED)scribble_hed同上
Shufflecontrol_v11e_sd15_shuffleShuffleshuffle通过打乱参考图的内容和颜色生成新的图片。
Soft Edgecontrol_v11p_sd15_softedgeSoft Edge (HED)softedge_hed类似“Hard Edge”模型,但更粗略且生成结果更多样。
Soft Edgecontrol_v11p_sd15_softedgeSoft Edge (PiDiNet)softedge_pidinet同上
Straight Linecontrol_v11p_sd15_mlsdStraight Linemlsd仅根据参考图中的直线信息生成图片。
Tilecontrol_v11f1e_sd15_tileTiletile通过将参考图分块生成新的图片,用于增加图片细节或者放大。

请求

参数名类型描述信息必填
ActionString对应的 API 指令名称
PublicKeyString用户公钥,可从 PICPIK用户中心 (opens in a new tab) 获取
SignatureString根据公钥及 API 指令生成的用户签名,参见 签名算法
request_uuidString请求uuid,采用uuid生成方式随机生成,可用于管理您业务和客户的请求

请求示例

{
    "Action":    "ListControlNets",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "request_uuid":"b91fcfbe-bb35-47ce-a168-bd6252c75270",
    "Signature": "0131f4e4296f3ca8e1220b47247e83a4315ea8e1"
}

响应

字段名类型描述信息必填
RetCodeInt返回状态码,为 0 则为成功返回,非 0 为失败
ActionString操作指令名称
MessageString返回错误消息,当 RetCode 非 0 时提供详细的描述信息
request_uuidString返回请求时填写的uuid
字段名类型描述信息必填
PreProcessorsMap[String]PreProcessorControlNet预处理器列表
ControlModelsMap[String]ControlModelControlNet模型列表

复杂数据类型说明

PreProcessor

参数名类型描述信息必填
ModelCodeStringControlNet预处理器编码
InferenceParamsInferenceParamsControlNet预处理器推理参数

ControlModel

参数名类型描述信息必填
ModelCodeStringControlModel模型编码
InferenceParamsInferenceParamsControlModel推理参数

InferenceParams

注意:特定参数仅对某个特定的模型数据类型(父级)生效,并不通用。

参数名类型有效的父级类型描述信息默认值范围步长必填
LoraWeightFloatModel推理时的模型权重, 仅对 LoRA模型生效1-1~20.01
ResolutionIntPreProcessorControlnet预处理器的生成分辨率51264~204864
ControlWeightFloatControlModelControlNet模型的推理权重10~20.01
StartingStepFloatControlModelControlNet模型开始介入推理的时机(比率)00~10.01
EndingStepFloatControlModelControlNet模型退出推理过程的时机(比率)10~10.01

响应示例

{
	"Action": "ListControlNets",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "06e47e54-253e-40d7-9002-a3f7d9d4cbdd",
	"PreProcessors": {
		"canny": {
			"Name": "canny",
			"ModelCode": "canny",
			"InferenceParams": {
				"Resolution": 512
			}
		}
		// more...
	},
	"ControlModels": {
		"control_v11e_sd15_ip2p": {
			"Name": "control_v11e_sd15_ip2p",
			"ModelCode": "control_v11e_sd15_ip2p",
			"InferenceParams": {
				"ControlWeight": 1,
				"StartingStep": 0,
				"EndingStep": 1
			}
		}
		// more ...
	}
}