Skip to main content
GET
List

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Query Parameters

limit
integer
default:50

Max items to return (1-500)

Required range: 1 <= x <= 500
offset
integer | null
default:0

Items to skip

Required range: x >= 0
sort
string

Comma-separated sort fields, prefix with - for descending. Allowed: index, status, started_at, finished_at

job_id
string
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

step_id
string
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

ids
string

Comma-separated task ids

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

node_id
string

Comma-separated node ids

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

status
string

Comma-separated statuses, e.g. working,failed

type
string

Comma-separated task types

index
string

Comma-separated frame indexes and ranges

Pattern: ^\d+(-\d+)?(,\d+(-\d+)?)*$
Example:

"1,4,10-20"

helper
boolean

Filter helper tasks in or out

fields
string

Comma-separated fields to return instead of the whole task

Example:

"index,status,thumbnail"

Response

Matching tasks

data
object[]
required
total
integer
required

Total matching the filter, ignoring limit/offset

limit
integer
required
offset
integer
required