Skip to content

by Startups.Studio

Video.draft

POST /{namespace}/videos/draft

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

Noun: Video
Mode: do
Event: Video.drafted

You, to your agent

Draft the latest video with a brand.

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

import { $ } from 'startup-builder'

const video = await $.Video.draft({ brand: 'brand_1' })

npx startup-builder do Video.draft --json '{"brand":"brand_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Video.draft({ brand: 'brand_1' })"
  }
}

Inputs

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

Outputs

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

Effects

Emits Video.drafted.
Performed by the Video Producer.
Every claim on screen links to the record it reads.

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.	Video.draft

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Video.create

Previous Page

Video.finalize

Next Page