Cancel a video

Stops a video that is still queued or rendering and returns its credits. A finished video is returned unchanged. Needs the videos:create permission.

POST

https://app.mosio.me/v1/videos/{id}/cancel

View as Markdown

Authorization

apiKeyAPI key in headerrequired

Path parameters

idstringrequired
The video id, such as vid_6f1c….

Returns

200

The video, now canceled (or unchanged if it had already finished).

JSON

idstringrequired
statusqueuedorrenderingordoneorfailedorcanceledrequired
templatestringrequired
The template id, composition for a rendered composition, or studio for a Studio project.
created_atstringrequired
format: date-time
finished_atstring | nullrequired
format: date-time
duration_secondsnumber | nullrequired
Length of the finished video.
output_urlstring | nullrequired
Short-lived link to the MP4 once status is done.
errorobject | nullrequired
Why the render failed, when status is failed. Failed videos spend no credits.
- codeoptionalstring
- messageoptionalstring
}

401

The API key is missing or not valid.

JSON

errorunauthorizedorinvalid_api_keyorinsufficient_scopeorforbiddenorinvalid_inputorunknown_template+9 morerequired
A stable error code.
messagestringrequired
A message for people, in Indonesian.
detailsoptionalunknown
More about the error, such as the fields to fix.

404

No such template or video in this workspace.

JSON

errorunauthorizedorinvalid_api_keyorinsufficient_scopeorforbiddenorinvalid_inputorunknown_template+9 morerequired
A stable error code.
messagestringrequired
A message for people, in Indonesian.
detailsoptionalunknown
More about the error, such as the fields to fix.