SD-获取任务列表

请求参数

Query 参数

finish

boolean

是否完成

可选

示例值:

true

page

number

分页

可选

示例值:

1

page_size

number

每页数量

可选

示例值:

20

publish

boolean

可选

是否已发布，已发布的人物可以在画廊显示

示例值:

false

Header 参数

Authorization

string

可选

默认值:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHBpcmVkIjoxNzI5MTQ2NzQzLCJ1c2VyX2lkIjo0fQ.Rhk2XHTo-x55Ry2zHfcE2M9XcgdFo1DkTPDhhwg8Bk4

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://127.0.0.1:5678/api/sd/jobs?finish=true&page=1&page_size=20&publish=false' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHBpcmVkIjoxNzI5MTQ2NzQzLCJ1c2VyX2lkIjo0fQ.Rhk2XHTo-x55Ry2zHfcE2M9XcgdFo1DkTPDhhwg8Bk4'

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误代码，0 表示成功，其他值表示失败

data

array[object (SdJob) {12}]

可选

id

integer

必需

>= 1<= 2147483647

user_id

integer

用户 ID

必需

>= -2147483648<= 2147483647

type

string

任务类别

可选

<= 20 字符

默认值:

txt2img

task_id

string

任务 ID

必需

<= 30 字符

prompt

string

会话提示词

必需

<= 2000 字符

img_url

string

图片URL

可选

<= 255 字符

params

string

绘画参数json

可选

<= 65535 字符

progress

integer

任务进度

可选

>= -2147483648<= 2147483647

默认值:

0

publish

integer

是否发布

必需

>= -2147483648<= 2147483647

err_msg

string

错误信息

可选

<= 255 字符

power

integer

消耗算力

必需

>= -2147483648<= 2147483647

默认值:

0

created_at

string <date-time>

必需

message

string | null

可选

错误信息，如果返回的 code 不为0，则此字段返回错误信息

示例

{
    "code": 0,
    "data": [
        {
            "id": 1,
            "user_id": -2147483648,
            "type": "txt2img",
            "task_id": "string",
            "prompt": "string",
            "img_url": "string",
            "params": "string",
            "progress": "0",
            "publish": -2147483648,
            "err_msg": "string",
            "power": "0",
            "created_at": "2019-08-24T14:15:22Z"
        }
    ],
    "message": "string"
}