Skip to content
VIDMOATDocs

Build a storyboard

POSThttps://api.vidmoat.com/v1/projects/{id}/storyboard/runs
Bearer tokenScope ai.agentagent steps, quoted per sceneTry it in the playground

Build the board on the server with the editing agent, one scene at a time. Each scene is its own run held to its card's requirements, with its own review; its verdict is written to the scene. Built scenes are skipped, so calling again carries on.

Path parameters#

  • idstringrequired
    The project id.

Body#

  • sceneIdsarray of strings
    Only these scenes. Default: every unbuilt scene.
  • maxCreditsinteger
    Refuse a board quoted above this, and stop between scenes when the next would pass it.
  • quoteOnlybooleandefault false
    Return the quote only.

Response#

Returns 200.

Response fields#

  • boardRunIdstring
    Poll GET /v1/storyboard-runs/{id}.
  • sceneIdstring
    The scene building first.
  • estimateobject
    Steps and credits per 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.
402plan_requiredThe plan has no server runs; build it in the editor instead (editorUrl).
409conflictNo board, every scene built, server runs turned off, or a run is already going on the project.
400invalid_requestmaxCredits is below the quote or out of range.