Skip to content

Share a render

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

Make a finished export's watch link (vidmoat.com/watch/...), or take it away. The link is unlisted: only people who have it can watch. It plays the choices when the export is interactive.

Path parameters#

  • idstringrequired
    The render job id.

Body#

  • sharebooleandefault true
    false takes the link away.
  • titlestring
    Shown on the watch page and in link previews. Longer than 120 characters is cut to 120. Default: the title it was last shared with, else the project name.

Response#

Returns 200.

Response fields#

  • sharedboolean
    Whether the export has a link now.
  • tokenstring
    The link's id, when shared.
  • urlstring
    The watch link, when shared.
  • titlestring
    The title on the watch page, when shared.

Errors#

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

StatusCodeWhen
400invalid_requestThe render has not finished, or share is not a boolean or title not a string.
402plan_requiredThe render belongs to a project you cannot edit ("Not your render").
404not_foundNo such render.
429rate_limitedMore than 20 share changes in 10 minutes on the account.