Skip to main content
GET
Read a video project: its summary, or one file (theme.css, shared.html, scenes/<id>.html).

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

canvasId
string
required

Query Parameters

companyId
string

Company ID

path
string

theme.css, shared.html or scenes/.html; omit for the summary

Response

The project summary, or one file of it

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)