API Reference
List Tasks Details

List Tasks Details

API 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 command name, which is ListTasksDetails for this API
PublicKeystringUser's public key, which can be obtained from the User Center (opens in a new tab)
SignaturestringUser's signature generated based on the public key and API command, see Signature
request_uuidstringRequest UUID, randomly generated using the UUID generation method
TaskUIDList[]stringTask UID list

Request Example

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

Response

Field NameTypeDescriptionRequired
RetCodeintReturn status code. 0 indicates a successful response, non-zero indicates a failure.
ActionstringOperation command name.
MessagestringError message returned. Provides detailed description when RetCode is non-zero.
request_uuidstringReturns the requested uuid
TaskDetailList[]TaskDetailTask Details List

TaskDetail

Field NameTypeDescriptionRequired
TaskUIDstringTask UID
ActionstringAction name for task execution
StatusstringTask status
~ GeneratedImageList ~~ []string ~~ Task result picture list ~
ImgList[]stringA list of image links for the results of various image generation functions
TxtList[]stringText list, used to infer the results of image description
ConsumeApiPointintAPI points consumed
ErrorCodeintError message when an error occurs
ErrorMassagestringError code when an error occurs, 0 indicates normal operation

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
	}]
}