API Reference (Legacy)
Get Task Detail

Get Task Detail

API GetGenerateTaskDetail

Introduction

⚠️

This interface is no longer maintained.

This interface is used to get the details and results of a task.

Request

Parameter NameTypeDescriptionRequired
ActionstringThe corresponding API command name, which is GetGenerateTaskDetail for this API
PublicKeystringUser's public key, which can be obtained from 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 UUID generation method
TaskUIDstringTask UID

Request Example

{
    "Action":    "GetGenerateTaskDetail",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "Signature": "fbe9cb6bad175e885e85b13f6a202bec59f48d90",
    "request_uuid":"random_uuid",
    "TaskUID": "cjr997tleg738lelk3n0"
    
}

Response

Field NameTypeDescriptionRequired
RetCodeintReturn status code. 0 indicates successful return, non-zero indicates failure
ActionstringOperation command name
MessagestringError message returned when RetCode is non-zero
TaskTypestringTask type
TaskStatusstringCurrent task status, possible values: Queuing, Running, Finished, Error
FinalPictureUrls[]stringResult picture URLs
TaskErrorMsgstringError message when an error occurs
TaskErrorCodeintError code when an error occurs, 0 indicates normal operation

Response Example

{
    "Action": "",
    "RetCode": 0,
    "Message": "",
    "TaskType": "TaskGeneratePicture",
    "TaskStatus": "Finished",
    "FinalPictureUrls": [
        "xxxxx.png"
    ],
    "TaskErrorMsg": "",
    "TaskErrorCode": 0
}