Skip to main content
GET
带分页和筛选列出任务

授权

X-API-Key
string
header
必填

API密钥认证。从您的用户设置中生成API密钥 位于https://platform.comfy.org/profile/api-keys。在X-API-Key头中传递密钥。

查询参数

status
string

筛选方式:一个或多个状态(逗号分隔)。如果未提供,则返回所有任务。

workflow_id
string

筛选方式:工作流ID(精确匹配)

output_type
enum<string>

筛选方式:输出媒体类型(仅适用于已完成的有输出的任务)

可用选项:
image,
video,
audio
sort_by
enum<string>
默认值:create_time

排序方式:字段(create_time = 任务提交时间,execution_time = 工作流运行耗时)

可用选项:
create_time,
execution_time
sort_order
enum<string>
默认值:desc

排序方向(asc = 升序,desc = 降序)

可用选项:
asc,
desc
offset
integer
默认值:0

分页偏移(从0开始)

必填范围: x >= 0
limit
integer
默认值:100

每页最大项数(1-1000)

必填范围: 1 <= x <= 1000

响应

成功: 任务已获取

jobs
object[]
必填

按指定排序字段排序的任务数组

pagination
object
必填