API Reference (Legacy)
List ControlNet Models

List ControlNet Models

API ListControlNetProcessor

Introduction

⚠️

This interface is no longer maintained.

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

Request

Parameter NameTypeDescriptionRequired
ActionstringCorresponding API command name, the current API is ListControlNetProcessor
PublicKeystringUser public key, which can be obtained from the User Center (opens in a new tab)
SignaturestringUser 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":    "ListControlNetProcessor",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "request_uuid": "0208ce01-504c-4c65-a7a4-29cb0517f3a7",
    "Signature": "653e1c90ec0fc6c323be77f2b3ec599b37d6c4b0"
}

Response

Field NameTypeDescriptionRequired
RetCodeintReturn status code, 0 means successful return, non-zero means failure
ActionstringOperation command name
MessagestringReturn error message, provide detailed description when RetCode is non-zero
ControlNetProcessorList[]ControlNetPreProcessorControlNet preprocessor
ModelList[]ControlNetModelControlNet model

ControlNetPreProcessor

Field NameTypeDescriptionRequired
IdintPrimary key ID
NamestringPreprocessor name
HasResolutionboolWhether it has resolution
Params[]PreProcessorParamControlNet parameters

PreProcessorParam

Field NameTypeDescriptionRequired
ParamNamestringParameter name
ParamDefaultValuefloatParameter default value
MiniMumfloat64Minimum value
MaxiMumfloat64Maximum value
Stepfloat64Parameter step

ControlNetModel

Field NameTypeDescriptionRequired
IdintPrimary key ID
NamestringModel 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"
        }
    ]
}