Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Params

Param name Description
asset_id
required

Asset ID

Validations:

  • Must be a String

video_clip_id
required

Video clip ID

Validations:

  • Must be a String

Examples

// Successful request
POST /api/v2/assets/5E7Jne6FjIBMQBnJT3H3/video_clips/2/render
200
{
  "message": "Successfully started the video clip render process"
}
// Asset not found
POST /api/v2/assets/:asset_id/video_clips/:video_clip_id/render
{
  "name": "Clip 1",
  "start_time": 5000,
  "end_time": 25000
}
404
{
  "error": "asset not found"
}
// Invalid parameters
POST /api/v2/assets/z-HrSpHQEe31kzKKrMNN/video_clips/:video_clip_id/render
404
{
  "error": "Couldn't find VideoClip with 'id'=:video_clip_id [WHERE \"video_clips\".\"asset_id\" = $1]"
}
// If rendering process fails
POST /api/v2/assets/bfTVxvb7mh44Re2dBFf5/video_clips/3/render
400
{
  "error": "Error while attempting to start video render process. Please try again or contact your administrator."
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters