Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

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

Path Parameters

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

"68b1f0c2a4d3e5f6a7b8c9d0"

Body

application/json
name
string
Required string length: 1 - 255
description
string
Maximum string length: 2000
color
string
Maximum string length: 32
icon
string
Maximum string length: 200
tags
string[]
Maximum array length: 50
Maximum string length: 64
group_id
string
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

priority
integer
Required range: 0 <= x <= 100
limit
integer

Max nodes per step; 0 means unlimited

Required range: x >= 0
max_batch_size
integer

Frames per task. Only affects tasks created after the change

Required range: x >= 1
whitelisted_nodes
string[]

Nodes allowed to run this job; empty means any node in the pool

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

Nodes kept off this job, whatever else they could render

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

Response

The updated job

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

"68b1f0c2a4d3e5f6a7b8c9d0"

name
string
default:""
required
status
enum<string>
required
Available options:
working,
finishing,
pending,
preparing,
submitting,
failed,
archived,
suspended,
scheduled,
queued,
completed,
disabled,
unknown
description
string
default:""
required
tags
string[]
required
priority
number
default:50
required
steps
object[]
required
dependencies
object[]
required
metadata
object[]
required
notifications
object[]
required
cleanup
object
required
assets
object[]
required
progress
object
required
user_id
string | null
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

api_key_id
string | null

The API key that submitted it

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

"68b1f0c2a4d3e5f6a7b8c9d0"

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

"68b1f0c2a4d3e5f6a7b8c9d0"

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

"68b1f0c2a4d3e5f6a7b8c9d0"

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

"68b1f0c2a4d3e5f6a7b8c9d0"

icon
string | null
thumbnail
string | null
color
string | null
env
object

Environment variables for every application the job starts, over the app's own. $NAME reads the value the app would have had.

Example:
errors
object[]
schedule_date
integer | null
Example:

1785846207000

created_at
integer | null
Example:

1785846207000

started_at
integer | null
Example:

1785846207000

finished_at
integer | null
Example:

1785846207000

archived_at
integer | null
Example:

1785846207000

removed_at
integer | null
Example:

1785846207000