API参考
获取任务详情及结果

查询任务的详情与结果

Action ListTasksDetails

简介

此接口用于查询任务的详情与结果

💡

对于API生成的图片,PICPIK仅保留24小时,请勿直接在业务中引用生成图片的URL。

请求

参数名类型描述信息必填
ActionString对应的 API 指令名称
PublicKeyString用户公钥,可从 PICPIK用户中心 (opens in a new tab) 获取
SignatureString根据公钥及 API 指令生成的用户签名,参见 签名算法
request_uuidString请求uuid,采用uuid生成方式随机生成,可用于管理您业务和客户的请求
参数名类型描述信息必填
TaskUIDList[]String任务UID列表

请求示例

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

响应

字段名类型描述信息必填
RetCodeInt返回状态码,为 0 则为成功返回,非 0 为失败
ActionString操作指令名称
MessageString返回错误消息,当 RetCode 非 0 时提供详细的描述信息
request_uuidString返回请求时填写的uuid
字段名类型描述信息必填
TaskDetailList[]TaskDetail任务详情列表

复杂数据类型说明

TaskDetail

字段名类型描述信息必填
TaskUIDString任务UID
ActionString任务执行的指令名称
StatusString任务状态
ImgList[]String图片链接列表,用于各种生图功能的结果
SeedInt生成图片的种子
TxtList[]String文本列表,用于反推图片描述的结果
ConsumeApiPointInt消耗的API点数
ErrorCodeInt出错时,任务错误信息,详见 错误码
ErrorMassageString出错时,任务错误编码,0为运行正常

响应示例

{
	"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"],
		"ConsumeApiPoint": 50,
		"ErrorMassage": "",
		"ErrorCode": 0
	}]
}