List Tasks Details

Action ListTasksDetails

Introduction

This interface is used to query task details and results.

💡

For API-generated images, PICPIK only retains them for 24 hours. Do not reference the URL of these images directly in your application.

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
TaskUIDList	`[]String`	Task UID list	✓

Request Example

{
    "Action": "ListTasksDetails",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "Signature": "8c862d163b6dbdbd583e8b0815d1a954b3fbb0e5",
    "TaskUIDList": [
        "ckti5nf2h4keq8mr9n00"
    ],
    "request_uuid": "ebe3bd1a-2fb6-4a85-a1bd-a5d556bf0f50"
}

Response

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.

Field Name	Type	Description	Required
TaskDetailList	`[]TaskDetail`	Task Details List	✓

Intro to Complex Data Types

`TaskDetail`

Field Name	Type	Description	Required
TaskUID	`String`	Task UID	✓
Action	`String`	Action name of the current task	✓
Status	`String`	Task status	✓
ImgList	`[]String`	A list of URLs for the generated images
Seed	`Int`	The seed of generated images
TxtList	`[]String`	A list of strings for the image descriptions
ConsumeApiPoint	`Int`	Credits consumed
ErrorCode	`Int`	The error code shows when an error occurs; 0 indicates no error. View the error codes
ErrorMassage	`String`	The error message shows when an error occurs

Response Example

{
	"Action": "ListTasksDetails",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "ebe3bd1a-2fb6-4a85-a1bd-a5d556bf0f50",
	"TaskDetailList": [{
		"TaskUID": "ckti5nf2h4keq8mr9n00",
		"Action": "GenerateImages",
		"Status": "Finished",
		"ImgList": ["xxx.png"],
		"Seed": 123456,
		"TxtList": ["1girl,solo,smile"],
		"ErrorMassage": "",
		"ErrorCode": 0
	}]
}

List Running Tasks Terminate Task