Video routes: draft, finalize

Reference for Video, one group of Video routes.

Video.draft

Draft writes a Video’s timeline from a Startup’s records, its Brand and a Template, with a draft mark on every frame. Verb page.

Text

POST /{namespace}/videos/draft

Body, as JSON: the inputs. Emits Video.drafted.

Inputs

Input	Type	Required	Description
`brand`	Brand	required	The Brand the Video speaks for.
`offer`	Offer		The Offer the Video presents.

Returns

Output	Type	Required	Description
`video`	Video	required	The drafted Video, in status `Draft`.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X POST https://api.sb/leaseline.app/videos/draft \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brand":"brand_PluVQrB1HF"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "video": {
    "$id": "https://api.sb/leaseline.app/videos/video_xVlGG2TxBA",
    "$type": "Video",
    "status": "Draft",
    "timeline": {},
    "brand": "brand_PluVQrB1HF"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Video.draft",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Video.finalize

Finalize lifts a Video’s draft mark once every claim it makes reads from a live record, so its cuts can be published. Verb page.