Skip to main content
POST
Estimate Render

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Body

application/json
preset
string | null

The preset to estimate for (render, the default).

gpu
string | null

Or a GPU model, e.g. L4.

frames
integer | null

Frames to render (1 for a still). Or seconds and fps.

Required range: 1 <= x <= 10000000
seconds
number | null

Video length in seconds (with fps).

Required range: x > 0
fps
number | null

Frames per second (with seconds).

Required range: 0 < x <= 1000
resolution
string | null

720p, 1080p, 1440p, 4k (or 480p, WxH). Default 1920x1080.

width
integer | null

Or a width in pixels (with height).

Required range: 16 <= x <= 16384
height
integer | null

Or a height in pixels (with width).

Required range: 16 <= x <= 16384
profile
enum<string>
default:std/final

The Vork render profile.

Available options:
std/previs,
std/draft,
std/final,
std/path
include_setup
boolean | null

Add the one-time vork setup of a new machine. Default: true, unless the machine (machine_id, or from_job's) already ran vork setup.

machine_id
string | null

A machine of yours: its GPU and image.

from_job
string | null

A finished vork render job of this scene on one of your machines: scale its measured speed (basis this_scene). Its machine's GPU is used unless you name one.

sample
MachineRenderSample · object | null

Or a render of this scene you timed yourself (basis this_scene).

Response

Successful Response

gpu
string
required

The GPU the estimate is for.

preset
string | null
required

Its preset, when it matches one.

frames
integer
required

Frames estimated.

width
integer
required

Width in pixels.

height
integer
required

Height in pixels.

profile
string
required

The Vork render profile.

seconds_low
number
required

Fast end of the whole job, setup included when asked.

seconds_typical
number
required

Typical whole job, setup included when asked.

seconds_high
number
required

Slow end, including up to a couple of minutes of first-use scene compilation.

seconds_per_frame
number
required

Typical seconds per frame at this size and profile.

setup_seconds
number
required

Typical one-time vork setup seconds included (0 when not).

usd_per_minute
number | null
required

The GPU's live price per minute (null when not offered now).

credits_per_minute
number | null
required

The same in credits.

usd_low
number | null
required

Cost at seconds_low.

usd_high
number | null
required

Cost at seconds_high.

credits_low
number | null
required

Credits at seconds_low.

credits_high
number | null
required

Credits at seconds_high.

basis
enum<string>
required

this_scene: scaled from a render of this scene (from_job or sample); measured: from recent real Vork renders on this GPU; default: built-in typical speeds.

Available options:
default,
measured,
this_scene
samples
integer
required

Renders the estimate is based on (0 for default).

note
string
required

What to tell the user, for agents.

alternatives
MachineEstimateAlternative · object[]

The same job on the other Vork presets your plan runs (render-lite, render, render-2x, render-4x), frames split across a multi-GPU machine's GPUs.

recommendation
MachineEstimateRecommendation · object | null

A preset that saves at least 30% of the wall time (and at least a minute) for at most 1.5x the total cost, the extra cost in its reason (null when none does).