Skip to main content
PUT
Write one scene of a video project (its markup, scoped style and script), or edit it.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

sceneId
string
required
canvasId
string
required

Body

application/json

The scene file (or edits to it) and its timing

Request body for writing a scene

companyId
string
required

Company ID

start
number

Second the scene starts

duration
number

Seconds it stays on screen

transitionIn
string

Entrance transition (Motion Kit scene transition name)

transitionOut
string

Exit transition, or "none" to hold

transitionDuration
number

Seconds the entrance takes

exitDuration
number

Seconds the exit takes

background
string

CSS background of the scene

html
string

The whole scene file: markup plus optional and <script>

edits
object[]

Instead of html: find/replace edits on the scene file

Response

Warnings about the project after the write

Video project

canvasId
string

Canvas ID of the project

summary
string

Scenes with timing, audio, fonts, files and the last render

path
string

The file read, when a path was given

content
string

That file's exact text

notes
string[]

Warnings worth checking after a change

guide
string

Scene file contract, partials and kit helpers (on create)