InPaint

Action GenerateCompletion

Introduction

⚠️

This interface is no longer maintained.

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

Request

Parameter Name	Type	Description	Required
Action	`String`	The corresponding API command name, the current API is `GenerateCompletion`	✓
PublicKey	`String`	User's public key, can be obtained from User Center (opens in a new tab)	✓
Signature	`String`	User signature generated based on public key and API command, see Signature	✓
request_uuid	`String`	Request UUID, randomly generated using UUID generation method
ModelType	`String`	Model 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`	✓
MainModelId	`Int`	Main model ID, if ModelType is `combined_model`, fill in the Id of `SystemPreInstallModels`, otherwise fill in the Id of `SelfMainModels`	✓
SubModelIds	`[]int`	Submodel list, do not fill in if ModelType is `combined_model`
SubModelParams	`[]SubModelParam`	Submodel parameters. If SubModelIds is used, the weight of the submodel can be controlled through this parameter.
BatchSize	`Int`	Batch image size 1~16	✓
Steps	`Int`	Iteration steps 1~150	✓
CfgScale	`Float`	Prompt word guidance level 0~30	✓
Seed	`Int`	Random number seed	✓
Sampler	`String`	Sampler,Reference Support Samplers	✓
Width	`Int`	Image generation width, max: 1440,min: 16	✓
Height	`Int`	Image generation height, max: 1440,min: 16	✓
ClipSkip	`Int`	ClipSkip	✓
TranslatePrompt	`Bool`	Whether to translate the prompt word into English	✓
PositivePrompts	`[]String`	Positive prompts
NegativePrompts	`[]String`	Negative prompts
ReferenceImage	`String`	Reference Source image base64
TransparentImg	`String`	Base64 of black and white mask, the white part is the redrawn part, the TransparentImg must avoid being compressed by third-party tools	✓
CompletionControlWeight	`Float`	weight for Completion	✓
CompletionStrengthenPrompt	`Bool`	Is prompt words more priority	✓
CompletionSigma	`Float`	Transparent edge radius	✓
EnableControlNet	`Bool`	Whether to enable controlNet
ControlNetParams	`[]ControlNetParam`	ControlNet parameters list (max length:3)
UseCustomMainModelVae	`Bool`	Using main model VAE ，true means use main model VAE，default false

ControlNetParam

Parameter Name	Type	Description
ControlNetImg	`String`	ControlNet image base64
ControlPreSetId	`String`	ControlNet Default parameter ID, 0: customized, 1: Graffiti and Sketch, 2: Figure's Pose, 3: Anime Line Drawing, 4: Spatial Line Drawing
ControlWeight	`Float`	ControlNet weight 0~2
ModelId	`Int`	ControlNet model Id
PreProcessorId	`Int`	ControlNet preprocessor Id
StartingControlStep	`Float`	ControlNet starting intervention step
EndingControlStep	`Float`	ControlNet ending intervention step
ControlMode	`String`	Control mode, reference value: Balanced、MyPromptIsMoreImportant、ControlNetIsMoreImportant
ResizeMode	`String`	Resize mode, reference value: JustResize、CropAndResize、ResizeAndFill
PreProcessorResolution	`Int`	PreProcessorResolution
Param1Value	`Float`	Parameter 1
Param2Value	`Float`	Parameter 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

SubModelParam

参数名	类型	描述信息	必填
SubModelId	`Int`	Sub model Id
ControlWeight	`Float`	Sub 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"
}

Response

Parameter 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, provide detailed description when `RetCode` is non-zero
TaskUID	`String`	Task UID, used to query task details and get results	✓

Response Example

{
    "Action":"",
    "RetCode":0,
    "Message":"",
    "TaskUID":"cjr997tleg738lelk3n0"
}

Swap Face Get Usage of API Credits