API Reference
List Models

List Generation Models

Action ListModels

Introduction

This interface is used to query the generation models list.

Request

Parameter NameTypeDescriptionRequired
ActionStringThe corresponding API instruction name
PublicKeyStringUser's public key, which can be obtained from the PICPIK User Center (opens in a new tab)
SignatureStringUser's signature generated based on the public key and API instruction, see Signature for details
request_uuidStringRequest UUID, randomly generated by using the UUID generation method. This parameter can be utilized to manage the requests of your business and clients.

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 return, while non-zero indicates a failure
ActionStringInstruction name
MessageStringThe error message is returned when RetCode is non-zero, providing a detailed description
request_uuidStringReturns the UUID that were included in the request
Field NameTypeDescriptionRequired
MainModelsMap[String]ModelMain models
LoraModelsMap[String]ModelLora models
EmbeddingModelsMap[String]ModelEmbedding models
HypernetworkModelsMap[String]ModelHypernetwork models

Intro to Complex Data Types

Model

Field NameTypeDescriptionRequired
NameStringModel name
ModelCodeStringModel code
IsOfficialBoolIs official model or not
TriggerWordList[]StringTrigger word list, only available with LoRA model
InferenceParamsInferenceParamsInference parameters

InferenceParams

Note: Specific parameters are only valid for a particular model data type (parent) and are not generic.

Parameter NameTypeValid Parent TypeDescriptionDefaultRangeStepRequired
LoraWeightFloatModelThe influence weight when inferencing. Only available with the LoRA model.1-1~20.01
ResolutionIntPreProcessorThe resolution of images generated by the pre-processor.51264~204864
ControlWeightFloatControlModelThe influence weight of a ControlNet model when inferencing.10~20.01
StartingStepFloatControlModelTiming (ratio) of a ControlNet model to start intervening in the inference process.00~10.01
EndingStepFloatControlModelTiming (ratio) of a ControlNet model to stop intervening in the inference process.10~10.01

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...
	}
}