Fetch task by id - API reference

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

任务ID

Query Params

string

optional

Header Params

string

optional

Authorization

string

optional

Default:

Responses

🟢200OK

application/json

Body

action

enum<string>

optional

任务类型

Allowed values:

IMAGINEUPSCALEVARIATIONZOOMPANDESCRIBEBLENDSHORTENSWAP_FACE

buttons

array[object (可执行按钮) {5}]

optional

customId

string

optional

动作标识

emoji

string

optional

图标

label

string

optional

文本

style

integer <int32>

optional

样式: 2（Primary）、3（Green）

type

integer <int32>

optional

类型，系统内部使用

description

string

optional

任务描述

failReason

string

optional

失败原因

finishTime

integer <int64>

optional

结束时间

string

optional

imageUrl

string

optional

图片url

progress

string

optional

任务进度

prompt

string

optional

提示词

promptEn

string

optional

提示词-英文

properties

object

optional

startTime

integer <int64>

optional

开始执行时间

state

string

optional

自定义参数

status

enum<string>

optional

任务状态

Allowed values:

NOT_STARTSUBMITTEDMODALIN_PROGRESSFAILURESUCCESSCANCEL

submitTime

integer <int64>

optional

提交时间

Example

{
  "action": "IMAGINE",
  "buttons": [
    {
      "customId": "string",
      "emoji": "string",
      "label": "string",
      "style": 0,
      "type": 0
    }
  ],
  "description": "string",
  "failReason": "string",
  "finishTime": 0,
  "id": "string",
  "imageUrl": "string",
  "progress": "string",
  "prompt": "string",
  "promptEn": "string",
  "properties": {},
  "startTime": 0,
  "state": "string",
  "status": "NOT_START",
  "submitTime": 0
}

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found