Skip to content

Publish choices

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

Put an interactive project's choices on one of its finished exports so its watch link plays them, update them after a change without rendering again, or take them off.

Path parameters#

  • idstringrequired
    The project id.

Body#

  • exportIdstringrequired
    The export (render job id) to publish on. It must still show the project's picture: samePicture in the list.
  • publishbooleandefault true
    false takes the choices off; the video plays as an ordinary one.
  • shareboolean
    true also makes the watch link and returns it as shareUrl; false takes the link away. Omit to leave the link as it is.

Response#

Returns 200.

Response fields#

  • okboolean
    true.
  • publishedboolean
    Whether the export carries choices now.
  • scenesinteger
    With publish: true: scenes published.
  • itemsinteger
    With publish: true: interactive parts published.
  • shareUrlstring or null
    With publish: true: the watch link, or null when the export has none.
  • notestring
    With publish: true, no link and no share sent: how to make one.
  • sharedboolean
    Only when share was sent: whether the export has a link now.
  • shareErrorstring
    Only when share was sent and changing the link failed. The publish itself still happened.

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_requestexportId is missing, or publish or share is not a boolean.
402plan_requiredThe plan cannot publish an interactive link, or interactive video is not switched on for this account.
409conflictThe export has not finished, was made before exports were fingerprinted, or the picture changed since (render again); the project has no choices; or the choices would leave a viewer stuck (problems lists them).