Skip to content
VIDMOATDocs

Get the storyboard

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

The project's scenes in timeline order. A scene stores intent (title, script, voice, footage, look, captions, target length); its span comes from the clips that carry its sceneId, so it is always current. Includes the board's problems and a quote per unbuilt scene.

Path parameters#

  • idstringrequired
    The project id.

Response#

Returns 200.

Response fields#

  • hasStoryboardboolean
    Whether the project has a board.
  • scenesarray
    { id, index, title, start, end, seconds, targetSeconds?, script?, voice?, footage?, captions?, locked?, clipIds, placeholders, built, review? } in timeline order. start/end are null for an empty scene.
  • problemsarray
    { sceneId?, severity, code, message }: empty scenes, placeholder slots, overlaps, a scene far from its target, captions asked for and missing.
  • estimateobject
    { scenes: [{ sceneId, steps, credits, built }], total, remaining } for a run of the unbuilt scenes.
  • nextScenestring or null
    The first unbuilt scene.

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.