Video clips

Headers

Params

Examples

// Successful request
GET /api/v2/assets/PmbEFV_dkhMYnuU-3SQQ/video_clips
200
{
  "video_clips": []
}

// Asset not found
GET /api/v2/assets/:asset_id/video_clips
404
{
  "error": "asset not found"
}

Errors

Headers

Params

Examples

// Successful request
POST /api/v2/assets/lMzPb1YQJmMvH91nGm7C/video_clips
{
  "name": "Clip 1",
  "start_time": 5000,
  "end_time": 25000
}
200
{
  "video_clip": {
    "id": 1,
    "name": "Clip 1",
    "start_time": 5000,
    "end_time": 25000
  }
}

// Asset not found
POST /api/v2/assets/:asset_id/video_clips
{
  "name": "Clip 1",
  "start_time": 5000,
  "end_time": 25000
}
404
{
  "error": "asset not found"
}

// Invalid parameters
POST /api/v2/assets/MQfm4NLTJ_Y1l_m_-Utr/video_clips
{
  "name": "Clip 1",
  "start_time": 26000,
  "end_time": 25000
}
400
{
  "error": "Validation failed: Start time must be less than or equal to 25000, End time must be greater than or equal to 26000"
}

Errors

Headers

Params

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

Headers

Params

Examples

// Successful request
DELETE /api/v2/assets/-D3tYRKfQUYgIds-Enee/video_clips/4
200
{
  "video_clips": []
}

// Asset not found
DELETE /api/v2/assets/:asset_id/video_clips/:video_clip_id
{
  "name": "Clip 1",
  "start_time": 5000,
  "end_time": 25000
}
404
{
  "error": "asset not found"
}

// Invalid parameters
DELETE /api/v2/assets/TNY4MBdAID95HcvYHwJM/video_clips/:video_clip_id
404
{
  "error": "Couldn't find VideoClip with 'id'=:video_clip_id [WHERE \"video_clips\".\"asset_id\" = $1]"
}

// If deletion process fails
DELETE /api/v2/assets/GJHBSY1iIUKWpL4moiri/video_clips/5
400
{
  "error": "ActiveRecord::RecordNotDestroyed"
}

Errors