Skip to main content
POST
Open submitter

Authorizations

Authorization
string
header
required

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

Query Parameters

user
string

Whose desktop to open it on; two people signed in to one machine each have their own

Maximum string length: 256
batch
boolean

false opens the single job even when the scene lists render items; omitted follows the submitter's own default, which is one job per item

Body

application/json
file
string
required
host
object
required
type
enum<string>
required
Available options:
3dsmax.render
live_host
object
name
string
Required string length: 2 - 255
engine
object
plugins
object[]
status
enum<string>
Available options:
pending,
suspended
priority
number
Required range: 0 <= x <= 100
dependencies
string[]
Pattern: ^[a-fA-F0-9]{24}$
nodes
string[]
Pattern: ^[a-fA-F0-9]{24}$
blacklisted_nodes
string[]

Machines kept off this job, whatever else they could render

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

The machine that runs this step's render. A distributed render's dispatcher. It must be one of nodes when those are given

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

"68b1f0c2a4d3e5f6a7b8c9d0"

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

"68b1f0c2a4d3e5f6a7b8c9d0"

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:
licenses
string[]

Render licences the step takes a seat of, by name. For what the scene cannot say, like a plugin inside it

Maximum array length: 50
Maximum string length: 64
Pattern: ^[a-z0-9_-]+$
metadata
object[]

Labelled values the job carries: a show, a shot, an artist

_v
integer
Required range: x >= 1
scene
object
spec
object
camera
string
frame
string

Single frame, range, range with step, or list

Example:

"1-100:4"

resolution
string
Pattern: ^\d+x\d+$
Example:

"1920x1080"

tiled
output
object[]
distributed
boolean

Response

Whether the submitter opened. opened: false with a reason when the desktop app isn't running. The request itself succeeded

opened
boolean
required
reason
string

Why the submitter could not be opened