API Reference
List ControlNet Models

List ControlNet models and processors

API ListControlNets

Introduction

This interface is used to query the ControlNet model and processor list

Request

Parameter NameTypeDescriptionRequired
ActionstringThe corresponding API command name, which is ListControlNets for this API
PublicKeystringUser's public key, which can be obtained from the User Center (opens in a new tab)
SignaturestringUser's signature generated based on the public key and API command, see Signature
request_uuidstringRequest UUID, randomly generated using the UUID generation method

Request Example

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

Response

Field NameTypeDescriptionRequired
RetCodeintReturn status code. 0 indicates a successful response, non-zero indicates a failure.
ActionstringOperation command name.
MessagestringError message returned. Provides detailed description when RetCode is non-zero.
request_uuidstringReturns the requested uuid
PreProcessorsmap[string]PreProcessorPreProcessor,Refer to PreProcessor
ControlModelsmap[string]ControlModelControlNet Model,Refer to ControlModel

Response Example

{
	"Action": "ListControlNets",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "06e47e54-253e-40d7-9002-a3f7d9d4cbdd",
	"PreProcessors": {
		"canny": {
			"Name": "canny",
			"ModelCode": "canny",
			"InferenceParams": {
				"CannyHighThreshold": 200,
				"CannyLowThreshold": 100,
				"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,
				"ControlMode": "Balanced",
				"ResizeMode": "ResizeAndFill"
			}
		}
		// more ...
	}
}