Pattern Conversion

Action ApplyReferencePattern

Introduction

This interface redraws the masked area of the raw image by referencing the pattern in the reference image.

Request

Parameter Name	Type	Description	Required
Action	`String`	The corresponding API instruction name	✓
PublicKey	`String`	User's public key, which can be obtained from the PICPIK User Center (opens in a new tab)	✓
Signature	`String`	User's signature generated based on the public key and API instruction, see Signature for details	✓
request_uuid	`String`	Request UUID, randomly generated by using the UUID generation method. This parameter can be utilized to manage the requests of your business and clients.

Parameter Name	Type	Description	Required
MainModel	`Model`	Main model for generating images	✓
SubModelList	`[]Model`	The submodel list for generating images includes LoRA, Embedding, and HyperNetwork.
PositivePrompts	`[]String`	Content description of what you want to appear in the image.
NegativePrompts	`[]String`	Content description of what you do not want to appear in the image.
TranslatePrompts	`Bool`	Translate other languages to English, see support language list here. Default value: true
Seed	`Int`	The number of a seed (-1~2147483647), -1 represents a ramdom seed. Default value: -1
Width	`Int`	Image width (64~2560). Default value: 1024
Height	`Int`	Image height (64~2560). Default value: 1024
BatchSize	`Int`	Batch size for generating images (1~16). Default value: 1
UseMainModelVAE	`Bool`	Whether to use the codec that comes with the main model. Default value: false

Parameter Name	Type	Description	Required
RawImageIndex	`Int`	The index of the raw image in ImageAndMaskList, starting from 0.	✓
MaskIndex	`Int`	The index of the mask in ImageAndMaskList, starting from 0.	✓
PatternImageIndex	`Int`	The index of the style refenrence image in ImageAndMaskList, starting from 0.	✓
PatternReferStrength	`Float`	The reference strength of the style refenrence image (0~1). Default value: 0.5
ChaoticMode	`Bool`	Chaotic mode. If the result is not good, you can try to open. Default value: false
ColorCorrection	`Bool`	Color correction. If the color deviation is large, you can try to turn on correction, but it does not work in chaos mode. Default value: false
ImageAndMaskList	`[]Base64`	A list of reference images and masks encoded in Base64.

Intro to Complex Data Types

`Model`

Field Name	Type	Description	Required
Name	`String`	Model name
ModelCode	`String`	Model code	✓
IsOfficial	`Bool`	Is official model or not
TriggerWordList	`[]String`	Trigger word list, only available with LoRA model
InferenceParams	`InferenceParams`	Inference parameters

Request Example

{
    "Action": "ApplyReferencePattern",
    "MainModel": {
      	"ModelCode"  : "PICPIK General"
    },
    "PositivePrompts": ["photo-realistic", "real-life", "studio light", "still-life photography"],
    "RawImageIndex": 0,
    "MaskIndex": 1,
    "PatternImageIndex": 2,
    "ChaoticMode": false,
    "ColorCorrection": false,
    "ImageAndMaskList": ["imagebase64","imagebase64","imagebase64"]
}

Response

Field Name	Type	Description	Required
RetCode	`Int`	Return status code: 0 indicates a successful return, while non-zero indicates a failure	✓
Action	`String`	Instruction name	✓
Message	`String`	The error message is returned when `RetCode` is non-zero, providing a detailed description
request_uuid	`String`	Returns the UUID that was included in the request

Parameter Name	Type	Description	Required
TaskUID	`String`	Task UID, used to query task details and get results	✓

Response Example

{
	"Action": "ApplyReferencePattern",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "8482d350-04f9-421b-817b-1d98b3a4dcfa",
	"TaskUID": "cktlm6lrh4xxx8ng9nf0"
}

Pattern Extraction & Redraw Resize Image