API Reference (Legacy)


API GenerateCompletion



This interface is no longer maintained.

This interface will redraw masked pixels by your prompts and reference images.


Parameter NameTypeDescriptionRequired
ActionstringThe corresponding API command name, the current API is GenerateCompletion
PublicKeystringUser's public key, can be obtained from User Center (opens in a new tab)
SignaturestringUser signature generated based on public key and API command, see Signature
request_uuidstringRequest UUID, randomly generated using UUID generation method
ModelTypestringModel type, reference value: combined_model, custom_model. To use the official model provided by PICPIK, you need to fill in combined_model, and to use a self-trained or uploaded model, you need to fill in custom_model
MainModelIdintMain model ID, if ModelType is combined_model, fill in the Id of SystemPreInstallModels, otherwise fill in the Id of SelfMainModels
SubModelIds[]intSubmodel list, do not fill in if ModelType is combined_model
SubModelParams[]SubModelParamSubmodel parameters. If SubModelIds is used, the weight of the submodel can be controlled through this parameter.
BatchSizeintBatch image size 1~16
StepsintIteration steps 1~150
CfgScalefloatPrompt word guidance level 0~30
SeedintRandom number seed
SamplerstringSampler,Reference Support Samplers
WidthintImage generation width, max: 1440,min: 16
HeightintImage generation height, max: 1440,min: 16
TranslatePromptboolWhether to translate the prompt word into English
PositivePrompts[]stringPositive prompts
NegativePrompts[]stringNegative prompts
ReferenceImagestringReference Source image base64
TransparentImgstringBase64 of black and white mask, the white part is the redrawn part, the TransparentImg must avoid being compressed by third-party tools
CompletionControlWeightfloatweight for Completion
CompletionStrengthenPromptboolIs prompt words more priority
CompletionSigmafloatTransparent edge radius
EnableControlNetboolWhether to enable controlNet
ControlNetParams[]ControlNetParam ControlNet parameters list (max length:3)
UseCustomMainModelVaeboolUsing main model VAE ,true means use main model VAE,default false


Parameter NameTypeDescriptionRequired
ControlNetImgstringControlNet image base64
ControlPreSetIdstringControlNet Default parameter ID, 0: customized, 1: Graffiti and Sketch, 2: Figure's Pose, 3: Anime Line Drawing, 4: Spatial Line Drawing
ControlWeightfloatControlNet weight 0~2
ModelIdintControlNet model Id
PreProcessorIdintControlNet preprocessor Id
StartingControlStepfloatControlNet starting intervention step
EndingControlStepfloatControlNet ending intervention step
ControlModestringControl mode, reference value: Balanced、MyPromptIsMoreImportant、ControlNetIsMoreImportant
ResizeModestringResize mode, reference value: JustResize、CropAndResize、ResizeAndFill
Param1ValuefloatParameter 1
Param2ValuefloatParameter 2

Note: If ControlPreSetId is not 0, you only need to fill in the ControlNetImg and ControlWeight parameter. Otherwise, all parameters need to be filled in. Parameter referenceControlNet Model List


SubModelIdintSub model Id
ControlWeightfloatSub model control weight(Lora weight)

Request Example

	"Action": "GenerateCompletion",
	"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
	"request_uuid": "b91fcfbe-bb35-47ce-a168-bd6252c75270",
	"Signature": "743c5804b6ab6e5ac0e4e606d38a222272ad1739",
	"ModelType": "combined_model",
	"MainModelId": 1,
	"BatchSize": 2,
	"Steps": 20,
	"CfgScale": 8,
	"Seed": -1,
	"Sampler": "Euler a",
	"ClipSkip": 1,
	"Width": 1230,
	"Height": 750,
	"PositivePrompts": [],
	"NegativePrompts": [],
	"TranslatePrompt": true,
	"CompletionControlWeight": 1,
	"CompletionStrengthenPrompt": false,
	"CompletionSigma": 10,
	"TransparentImg": "data:image/jpeg;base64,xxx",
	"ReferenceImage": "data:image/jpeg;base64,xxx"


Parameter NameTypeDescriptionRequired
RetCodeintReturn status code, 0 for successful return, non-zero for failure
ActionstringOperation command name
MessagestringReturn error message, provide detailed description when RetCode is non-zero
TaskUIDstringTask UID, used to query task details and get results

Response Example