API Reference
List Models

List SD Models

API ListModels

Introduction

This interface is used to query the model list

The model management module is under development. For now, if you wish to use an unofficial model, please contact us and we will manually upload it for you after review.

Request

Parameter NameTypeDescriptionRequired
ActionstringThe corresponding API command name, which is ListModels 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":    "ListModels",
    "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
MainModelsmap[string]ModelMain models
LoraModelsmap[string]ModelLora models
EmbeddingModelsmap[string]ModelEmbedding models
HypernetworkModelsmap[string]ModelHypernetwork models

Model

Field NameTypeDescriptionRequired
NamestringModel Name
ModelCodestringModel Code
IsOfficialboolIs it an official model
TriggerWordList[]stringTrigger Word
InferenceParamsInferenceParamsModel inference parameter

InferenceParam

Parameter NameTypeDescriptionRequired
StepsintSteps(1~100)
SamplerstringSampler,Refer to Support Samplers
ClipSkipintPrompt word to skip levels(1~12)
CFGScalefloat64Prompt word guidance level(1~30)
LoraWeightfloat64Lora weight (only valid when the model is lora)

Response Example

{
	"Action": "ListModels",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "84a53e05-5db6-432a-a15a-184b8c934858",
	"MainModels": {
		"PICPIK 3D icon": {
			"Name": "三维图标",
			"ModelCode": "PICPIK 3D icon",
			"ModelType": "",
			"IsOfficial": true,
			"InferenceParams": {
				"Steps": 10,
				"Sampler": "Euler a",
				"ClipSkip": 2,
				"CFGScale": 7,
				"LoraWeight": 0
			}
		},
		"PICPIK Anime": {
			"Name": "动漫",
			"ModelCode": "PICPIK Anime",
			"ModelType": "",
			"IsOfficial": true,
			"InferenceParams": {
				"Steps": 10,
				"Sampler": "Euler a",
				"ClipSkip": 2,
				"CFGScale": 8,
				"LoraWeight": 0
			}
		},
		//more...
	},
	"LoraModels": {
		"SubModel1_20230801_151342": {
			"Name": "SubModel1_20230801_151342",
			"ModelCode": "SubModel1_20230801_151342",
			"ModelType": "",
			"IsOfficial": false
		},
		//more...
	}
}