Skip to content
VIDMOATDocs

Stop a board run

DELETEhttps://api.vidmoat.com/v1/storyboard-runs/{id}
Bearer tokenScope ai.agentFreeTry it in the playground

Stop the scene building now; no further scene starts. Finished scenes keep their edits and verdicts.

Path parameters#

  • idstringrequired
    The boardRunId.

Response#

Returns 200.

Response fields#

  • stoppedboolean
    A live scene was stopped.
  • completedScenesarray of strings
    Scenes that finished.

Errors#

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

StatusCodeWhen
404not_foundNo such board run on this account.