List Available Models

Action ListAvailableModel

Introduction

⚠️

This interface is no longer maintained.

This interface is used to get the list of available models for the current user.

Request

Parameter Name	Type	Description	Required
Action	`String`	The corresponding API command name, which is `ListAvailableModel` for this API	✓
PublicKey	`String`	User's public key, which can be obtained from 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 UUID generation method

Request Example

{
    "Action":    "ListAvailableModel",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "request_uuid": "fdee566e-24dc-4e28-bd96-9b7af621b6ec",
    "Signature": "fbe9cb6bad175e885e85b13f6a202bec59f48d90"
}

Response

Field Name	Type	Description	Required
RetCode	`Int`	Return status code, 0 for successful return, non-zero for failure	✓
Action	`String`	Operation command name	✓
Message	`String`	Return error message, provides detailed description when `RetCode` is non-zero
SystemPreInstallModels	`[]SystemPreInstallModel`	System pre-installed models	✓
SelfMainModel	`[]SelfMainModel`	Self-owned main models
SelfSubModel	`[]SubModel`	Self-owned sub models

SystemPreInstallModel

Field Name	Type	Description	Required
Id	`Int`	Primary key ID	✓
Name	`String`	Model name
Code	`String`	Model Code
Recommend	`String`	Usage recommendation
DefaultParams	`DefaultParam`	Default parameters

DefaultParam

Field Name	Type	Description
Steps	`Int`	Iteration steps
CfgScale	`Float`	Prompt word guidance level
Sampler	`String`	Sampling method
ClipSkip	`Int`	ClipSkip
UpScaler	`String`	Enlarge algorithm

SelfMainModel

Field Name	Type	Description	Required
Id	`Int`	Primary key ID	✓
Name	`String`	Model name
Code	`String`	Model Code
Recommend	`String`	Usage recommendation

SubModel

Field Name	Type	Description	Required
Id	`Int`	Primary key ID	✓
Name	`String`	Model name
Code	`String`	Model Code
Recommend	`String`	Usage recommendation
ModelType	`String`	Model type, reference value: lora, text inversion

Response Example

{
    "Action":"",
    "RetCode":0,
    "Message":"",
    "SystemPreInstallModels":[
        {
            "Id":1,
            "Name":"General",
            "DisplayName":"General",
            "Recommend":"Suitable for all objects, realistic style, rich in details",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":7.5,
                "Sampler":"Euler",
                "ClipSkip":1,
                "UpScaler":"R-ESRGAN 4x+"
            }
        },
        {
            "Id":2,
            "Name":"Landscape",
            "DisplayName":"Landscape",
            "Recommend":"Suitable for realistic natural scenery, urban street scenes, etc.",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":7.5,
                "Sampler":"Euler",
                "ClipSkip":2,
                "UpScaler":"R-ESRGAN 4x+"
            }
        },
        {
            "Id":4,
            "Name":"Portrait",
            "DisplayName":"Portrait",
            "Recommend":"Suitable for realistic portraits",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":7.5,
                "Sampler":"Euler",
                "ClipSkip":1,
                "UpScaler":"R-ESRGAN 4x+"
            }
        },
        {
            "Id":5,
            "Name":"Industrial Product",
            "DisplayName":"Industrial Product",
            "Recommend":"Suitable for industrial product concepts or renderings. For more details, choose the \"4x_NMKD-Siax_200k\" or \"4x-UniScaleV2_Moderate\" upscaling algorithm",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":7.5,
                "Sampler":"DPM++ 2M SDE Karras",
                "ClipSkip":2,
                "UpScaler":"R-ESRGAN 4x+"
            }
        },
        {
            "Id":11,
            "Name":"3D Icon",
            "DisplayName":"3D Icon",
            "Recommend":"Suitable for technology websites, main visuals, illustrations, etc. It is recommended to use reference images during generation.",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":7,
                "Sampler":"Euler a",
                "ClipSkip":2,
                "UpScaler":"R-ESRGAN 4x+ Anime6B"
            }
        },
        {
            "Id":8,
            "Name":"Architecture",
            "DisplayName":"Architecture",
            "Recommend":"Suitable for architectural facade design concepts or renderings. To obtain accurate and clear generation results, it is recommended to include lighting conditions, environment, weather conditions, and main colors of the building in the prompts.",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":7.5,
                "Sampler":"DPM++ 2M SDE Karras",
                "ClipSkip":2,
                "UpScaler":"R-ESRGAN 4x+"
            }
        },
        {
            "Id":9,
            "Name":"Interior Design",
            "DisplayName":"Interior Design",
            "Recommend":"Suitable for conceptual or rendering of interior space design. To obtain accurate and clear generation results, it is recommended to include lighting, style, and main color tones in the prompts.",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":7.5,
                "Sampler":"DPM++ 2M SDE Karras",
                "ClipSkip":2,
                "UpScaler":"R-ESRGAN 4x+"
            }
        },
        {
            "Id":10,
            "Name":"Anime",
            "DisplayName":"Anime",
            "Recommend":"Suitable for anime characters or scenes. If generating portraits, the recommended resolution is 512px*768px or 512px*1024px; if generating scenes, the recommended resolutions are 768px*512px, 1024px*512px, or 1536px*512px.",
            "DefaultParams":{
                "Steps":20,
                "CfgScale":8,
                "Sampler":"Euler a",
                "ClipSkip":2,
                "UpScaler":"R-ESRGAN 4x+ Anime6B"
            }
        }
    ],
    "SelfMainModels":[
        {
            "Id":1,
            "DisplayName":"PICPIK General",
            "Recommend":""
        },
        {
            "Id":2,
            "DisplayName":"PICPIK Landscape",
            "Recommend":""
        },
        {
            "Id":4,
            "DisplayName":"PICPIK Industrial Product",
            "Recommend":""
        },
        {
            "Id":6,
            "DisplayName":"PICPIK Architecture",
            "Recommend":""
        },
        {
            "Id":7,
            "DisplayName":"PICPIK Interior Design",
            "Recommend":""
        },
        {
            "Id":8,
            "DisplayName":"PICPIK Anime",
            "Recommend":""
        },
        {
            "Id":9,
            "DisplayName":"PICPIK Portrait",
            "Recommend":""
        },
        {
            "Id":10,
            "DisplayName":"PICPIK 3D Icon",
            "Recommend":""
        }
    ],
    "SelfSubModels":[
        {
            "Id":9999,
            "Name":"Test Training Set",
            "DisplayName":"Test Training Set",
            "Recommend":"",
            "ModelType":"lora"
        }
    ]
}

Error codes List ControlNet Models