Skip to content
VIDMOATDocs

Create a storyboard

POSThttps://api.vidmoat.com/v1/projects/{id}/storyboard
Bearer tokenScope projects.writeFreeTry it in the playground

Start a board from exactly one of: a template id (needs an empty project), a script (one paragraph becomes one scene, split by blank lines), or a list of scenes. Scenes with a target length get a placeholder slot.

Path parameters#

  • idstringrequired
    The project id.

Body#

  • fromobjectrequired
    { template }, { script } or { scenes }.
  • aspectRatiostring
    16:9, 9:16, 1:1, 4:5, 4:3 or 21:9.
  • replacebooleandefault false
    Replace an existing board; its clips stay as board-level clips.

Response#

Returns 200.

Response fields#

  • createdboolean
    Always true.
  • scenesarray
    As GET /v1/projects/{id}/storyboard.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
404not_foundNo such project, or it is not yours. The two are indistinguishable on purpose.
400invalid_requestfrom names none or several sources, or a scene breaks a limit.
409conflictThe project already has a board (pass replace), or a template was asked for a project with clips.