Skip to main content
GET
Retrieve

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"

Response

The pool

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

"68b1f0c2a4d3e5f6a7b8c9d0"

name
string
required
color
string
default:""
required
icon
string
default:""
required
description
string
default:""
required
priority
integer
default:0
required
node_limit
integer
default:0
required
readonly
boolean
default:false
required
lend_to
string[] | null
required
Pattern: ^[a-fA-F0-9]{24}$
reserve
integer
default:0
required
borrow
boolean
default:true
required
borrow_limit
integer
default:0
required
accept_types
enum<string>[] | null
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
max_priority
integer | null
required
max_node_limit
integer | null
required
created_at
integer
default:0
required
Example:

1785846207000

order
enum<string>
default:pool_priority_date
Available options:
pool_priority_date,
pool_priority_balanced
lend
enum<string>
default:none
Available options:
none,
idle,
surplus
cleanup
object | null