AI 接口文档

分页查询任务

POST

https://aigc.x-see.cn/mj/task/query

任务查询

请求参数

Header 参数

Authorization

string

必需

默认值:

API KEY 令牌

Content-Type

string

必需

默认值:

application/json

Body 参数application/json

pageNumber

integer <int32>

当前页, 从0开始

可选

示例值:

pageSize

integer <int32>

每页条数

可选

示例值:

sort

string

排序

可选

示例值:

id,desc

action

enum<string>

可选

枚举值:

IMAGINEUPSCALEVARIATIONZOOMPANDESCRIBEBLENDSHORTENSWAP_FACE

description

string

可选

ids

array[string]

可选

instanceId

string

可选

prompt

string

可选

promptEn

string

可选

state

string

可选

status

enum<string>

可选

枚举值:

NOT_STARTSUBMITTEDMODALIN_PROGRESSFAILURESUCCESSCANCEL

statusSet

array[string]

可选

枚举值:

NOT_STARTSUBMITTEDMODALIN_PROGRESSFAILURESUCCESSCANCEL

示例

{
  "pageNumber": 0,
  "pageSize": 10,
  "sort": "id,desc",
  "action": "IMAGINE",
  "description": "string",
  "ids": [
    "string"
  ],
  "instanceId": "string",
  "prompt": "string",
  "promptEn": "string",
  "state": "string",
  "status": "NOT_START",
  "statusSet": [
    "NOT_START"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aigc.x-see.cn/mj/task/query' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200OK

application/json

Body

content

array[object (任务) {15}]

可选

action

enum<string>

任务类型

可选

枚举值:

IMAGINEUPSCALEVARIATIONZOOMPANDESCRIBEBLENDSHORTENSWAP_FACE

buttons

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

可选

description

string

任务描述

可选

failReason

string

失败原因

可选

finishTime

integer <int64>

结束时间

可选

string

可选

imageUrl

string

图片url

可选

progress

string

任务进度

可选

prompt

string

提示词

可选

promptEn

string

提示词-英文

可选

properties

object

可选

startTime

integer <int64>

开始执行时间

可选

state

string

自定义参数

可选

status

enum<string>

任务状态

可选

枚举值:

NOT_STARTSUBMITTEDMODALIN_PROGRESSFAILURESUCCESSCANCEL

submitTime

integer <int64>

提交时间

可选

empty

boolean

可选

first

boolean

可选

last

boolean

可选

number

integer <int32>

可选

numberOfElements

integer <int32>

可选

pageable

object (Pageable)

可选

offset

integer <int64>

可选

pageNumber

integer <int32>

可选

pageSize

integer <int32>

可选

paged

boolean

可选

sort

object (Sort)

可选

unpaged

boolean

可选

size

integer <int32>

可选

sort

object (Sort)

可选

totalElements

integer <int64>

可选

totalPages

integer <int32>

可选

示例

{
  "content": [
    {
      "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
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

修改于 2024-04-08 15:23:58

根据ID列表查询任务

查询任务队列