API Reference
List Tasks Details

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 NameTypeDescriptionRequired
ActionStringThe corresponding API instruction name
PublicKeyStringUser's public key, which can be obtained from the PICPIK User Center (opens in a new tab)
SignatureStringUser's signature generated based on the public key and API instruction, see Signature for details
request_uuidStringRequest UUID, randomly generated by using the UUID generation method. This parameter can be utilized to manage the requests of your business and clients.
Parameter NameTypeDescriptionRequired
TaskUIDList[]StringTask UID list

Request Example

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

Response

Parameter NameTypeDescriptionRequired
ActionStringThe corresponding API instruction name
PublicKeyStringUser's public key, which can be obtained from the PICPIK User Center (opens in a new tab)
SignatureStringUser's signature generated based on the public key and API instruction, see Signature for details
request_uuidStringRequest UUID, randomly generated by using the UUID generation method. This parameter can be utilized to manage the requests of your business and clients.
Field NameTypeDescriptionRequired
TaskDetailList[]TaskDetailTask Details List

Intro to Complex Data Types

TaskDetail

Field NameTypeDescriptionRequired
TaskUIDStringTask UID
ActionStringAction name of the current task
StatusStringTask status
ImgList[]StringA list of URLs for the generated images
TxtList[]StringA list of strings for the image descriptions
ConsumeApiPointIntCredits consumed
ErrorCodeIntThe error code shows when an error occurs; 0 indicates no error. View the error codes
ErrorMassageStringThe 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",
		"GeneratedImageList": ["xxx.png"],   //Deprecated
		"ImgList": ["xxx.png"],
		"TxtList": ["1girl,solo,smile"],
		"ErrorMassage": "",
		"ErrorCode": 0
	}]
}