List ControlNet Models

Action ListControlNetProcessor

Introduction

⚠️

This interface is no longer maintained.

This interface is used to get the ControlNet model and preprocessor list.

Request

Parameter Name	Type	Description	Required
Action	`String`	Corresponding API command name, the current API is `ListControlNetProcessor`	✓
PublicKey	`String`	User public key, which can be obtained from the User Center (opens in a new tab)	✓
Signature	`String`	User signature generated based on the public key and API command, see Signature	✓
request_uuid	`String`	Request UUID, randomly generated using the UUID generation method

Request Example

{
    "Action":    "ListControlNetProcessor",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "request_uuid": "0208ce01-504c-4c65-a7a4-29cb0517f3a7",
    "Signature": "653e1c90ec0fc6c323be77f2b3ec599b37d6c4b0"
}

Response

Field Name	Type	Description	Required
RetCode	`Int`	Return status code, 0 means successful return, non-zero means failure	✓
Action	`String`	Operation command name	✓
Message	`String`	Return error message, provide detailed description when `RetCode` is non-zero
ControlNetProcessorList	`[]ControlNetPreProcessor`	ControlNet preprocessor	✓
ModelList	`[]ControlNetModel`	ControlNet model	✓

ControlNetPreProcessor

Field Name	Type	Description	Required
Id	`Int`	Primary key ID	✓
Name	`String`	Preprocessor name
HasResolution	`Bool`	Whether it has resolution	✓
Params	`[]PreProcessorParam`	ControlNet parameters

PreProcessorParam

Field Name	Type	Description
ParamName	`String`	Parameter name
ParamDefaultValue	`Float`	Parameter default value
MiniMum	`Float`	Minimum value
MaxiMum	`Float`	Maximum value
Step	`Float`	Parameter step

ControlNetModel

Field Name	Type	Description	Required
Id	`Int`	Primary key ID	✓
Name	`String`	Model name

Response Example

{
    "Action":"",
    "RetCode":0,
    "Message":"",
    "ControlNetPreProcessorList":[
        {
            "Id":2,
            "Name":"canny",
            "HasResolution":true,
            "Params":[
                {
                    "ParamName":"Canny Low Threshold",
                    "ParamDefaultValue":100,
                    "MiniMum":1,
                    "MaxiMum":255,
                    "Step":1
                },
                {
                    "ParamName":"Canny High Threshold",
                    "ParamDefaultValue":200,
                    "MiniMum":1,
                    "MaxiMum":255,
                    "Step":1
                }
            ]
        }
    ],
    "ModelList":[
        {
            "Id":1,
            "Name":"control_v11e_sd15_ip2p",
            "State":"ENABLE"
        }
    ]
}

List Available Models List Running Tasks