Skip to content
VIDMOATDocs

Get a board run

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

Each scene's run in a board run: status, outcome, review verdict and credits, the total spent, and the next unbuilt scene.

Path parameters#

  • idstringrequired
    The boardRunId.

Response#

Returns 200.

Response fields#

  • statusenum
    Where the board run is.
    One of running, stopped, settled
  • scenesarray
    { sceneId, title, runId, status, outcome, review, credits }.
  • creditsSpentinteger
    Net credits.

Errors#

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

StatusCodeWhen
404not_foundNo such board run on this account.