Skip to main content
POST
Stage scene

Authorizations

Authorization
string
header
required

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

Body

application/json
job_id
string
required

A reservation from POST /jobs/reserve

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

"68b1f0c2a4d3e5f6a7b8c9d0"

port
integer
required

The live host holding the scene. The port its RenderFlow plugin bound

file
string
required

The scene's path on this machine

Minimum string length: 1
save_option
enum<string>
required

copy writes it into the job's repository folder, overwrite writes it back where it is, none leaves it alone

Available options:
copy,
overwrite,
none

Response

Where the scene is now. Submit the step pointing at path

path
string
required

Where the scene is now. Submit the step pointing here

saved
boolean
required

False when the application reported no unsaved changes, which is not a failure