Video · StartupBuilder

Properties

Property	Type	Required	Description
`status`	`string`	required	One of `Draft`, `Rendered`, `Final`, or `Superseded`.
`timeline`	`json`	required	The ordered scenes on a fixed grid, the only timing truth for picture, voice and captions.
`brand`	Brand	required	The Brand whose voice, palette and type the Video uses.
`offer`	Offer		The Offer the Video presents, when it presents one.

Object

JSON

{
  "$id": "https://api.sb/routewise.dev/videos/video_1",
  "$type": "Video",
  "status": "Draft",
  "timeline": {},
  "brand": "brand_1",
  "offer": "offer_1"
}

Relationships

None.

Verbs

createCreates a Video.
POST /{namespace}/videosdoVideo.created
getReturns one Video by id.
GET /{namespace}/videos/{id}readNo Event
listReturns Videos, newest first, one page at a time.
GET /{namespace}/videosreadNo Event
updateChanges the given properties of a Video.
PATCH /{namespace}/videos/{id}doVideo.updated
draftDraft writes a Video’s timeline from a Startup’s records, its Brand and a Template, with a draft mark on every frame.
POST /{namespace}/videos/draftdoVideo.drafted
finalizeFinalize lifts a Video’s draft mark once every claim it makes reads from a live record, so its cuts can be published.
POST /{namespace}/videos/{video}/finalizedoVideo.finalized

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Video.create`	Yes	Yes	Yes	No
`Video.get`	Yes	Yes	Yes	Yes
`Video.list`	Yes	Yes	Yes	Yes
`Video.update`	Yes	Yes	Yes	No
`Video.draft`	Yes	Yes	Yes	No
`Video.finalize`	Yes	Yes	Yes	No

Call it

Text

Draft the latest video with a brand.

Example

A home-workout app drafts a 30-second Video from a timeline of clips and a script. Once its captions and loudness checks pass, Video.finalize renders cuts for vertical and square formats.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link