Skip to main content
GET
Step

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"

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

"68b1f0c2a4d3e5f6a7b8c9d0"

Response

The step

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

"68b1f0c2a4d3e5f6a7b8c9d0"

index
integer
default:0
required
name
string
default:""
required
type
enum<string>
required
Available options:
renderflow.test,
3dsmax.render,
3dsmax.scene_manager.render,
arnold.render,
after.render,
blender.render,
cinema4d.render,
houdini.batch,
houdini.mantra,
houdini.husk,
imager,
ffmpeg,
denoise,
autograph.render,
fusion.render,
harmony.render,
keyshot.render,
maya.render,
nuke.render,
renderman.render,
premiere.render,
media_encoder.encode,
davinci.render,
shell,
python,
unreal,
vray.dr.spawner,
redshift.render,
sketchup.render,
rhino.render,
vray_standalone,
vantage.render,
vred.render,
comfyui.render,
agentic,
3dsmax.script,
blender.script,
cinema4d.script,
maya.script,
houdini.script,
nuke.script,
fusion.script,
3dsmax.export,
maya.export,
blender.export,
cinema4d.export,
renderflow.custom_plugin,
renderflow.benchmark
reqs
object[]
required
props
object[]
required
output
object[]
required
nodes
object[]
required
whitelisted_nodes
string[]
required
blacklisted_nodes
string[]
required

Machines kept off this step, whatever else they could render

task_info
object
required
settings
object
required
tasks
(string | object)[]
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

progress
object
required
inputs
object[]
enabled
boolean
skipped
boolean
master_node_id
string | null

The machine this step's render is pinned to. A distributed render's dispatcher. Null means the matcher chooses

wait
object | null