Share a render
POST
https://api.vidmoat.com/v1/renders/{id}/shareMake 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#
idstringrequiredThe render job id.
Body#
sharebooleandefaulttruefalsetakes the link away.titlestringShown 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#
sharedbooleanWhether the export has a link now.tokenstringThe link's id, when shared.urlstringThe watch link, when shared.titlestringThe title on the watch page, when shared.
Errors#
Besides the errors any request can get (authentication, rate limits):
| Status | Code | When |
|---|---|---|
| 400 | invalid_request | The render has not finished, or share is not a boolean or title not a string. |
| 402 | plan_required | The render belongs to a project you cannot edit ("Not your render"). |
| 404 | not_found | No such render. |
| 429 | rate_limited | More than 20 share changes in 10 minutes on the account. |