Generate Images (SDXL)

Action GenerateImagesSDXL

Introduction

This interface generates images based on the SDXL model.

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

Parameter Name	Type	Description	Required
Image2Image	`Image2Image`	Related parameters of the reference graph used in addition to the generation
Tiling	`Bool`	Whether to generate tileable images, mainly used to generate stitching texture patterns. Default: false
ImageAndMaskList	`[]Base64`	Base64 encoded image and mask mask list	✓

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

`Image2Image`

Parameter Name	Type	Description	Required
ImageIndex	`Int`	The index of an image in `ImageAndMaskList` or `ImageList`, starting from 0.	✓
ReferStrength	`Float`	The reference strength of this image (0~1). Default value: 0.5

Request Example

{
    "Action": "GenerateImagesSDXL",
    "MainModel": {
      	"ModelCode"  : "PICPIK General"
    },
    "PositivePrompts": ["a apple"],
    "Image2Image": {
        "ImageIndex": 0,
        "ReferStrength": 0.5
    }
    "Tiling": false,
    "ImageAndMaskList": ["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": "GenerateImagesSDXL",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "8482d350-04f9-421b-817b-1d98b3a4dcfa",
	"TaskUID": "cktlm6lrh4xxx8ng9nf0"
}

Generate Images Inpaint & Outpaint