support Contact Support | system status System Status
Page Contents

    Retrieve Video Data

    This topic shows a variety of sample requests using the HTTP GET method.

    Introduction

    In this topic, you will learn how to retrieve various kinds of information about your Video Cloud videos, using CMS API requests. To create these requests, append the endpoints listed in this document to the base URL with your account id.

        https://cms.api.brightcove.com/v1/accounts/{account_id}/{endpoint}
        
        

    Requests to the CMS API require an authorization header which contain your access tokens. For details on how to obtain client credentials and use them to retrieve access tokens, see the Brightcove OAuth Overview.

    GET videos

    Retrieve data for all of the videos in your Video Cloud account.

    Endpoint: /videos

    Request

        https://cms.api.brightcove.com/v1/accounts/1507807800001/videos
        
        

    Response

        [ {
        "id" : "2114345471001",
        "account_id" : "1507807800001",
        "complete" : true,
        "created_at" : "2013-01-23T19:06:16.328Z",
        "cue_points" : [ {
        "name" : "Flying Off",
        "type" : "CODE",
        "time" : 2.64,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        }, {
        "name" : "Pre-roll",
        "type" : "AD",
        "time" : 0.0,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        }, {
        "name" : "Bird Back",
        "type" : "CODE",
        "time" : 5.938,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        }, {
        "name" : "Post-roll",
        "type" : "AD",
        "time" : 8.242,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        } ],
        "custom_fields" : {
        "customfield1" : "Approved",
        "customfield2" : "Verified"
        }, ...
        ]
        
        

    GET a video

    Retrieve data for a specific video, or multiple videos by id

    Endpoint: /videos/{video_id}[,{video2_id},{video3_id}]

    Request

        https://cms.api.brightcove.com/v1/accounts/1507807800001/videos/2114345471001
        
        

    Response

        {
        "id" : "2114345471001",
        "account_id" : "1507807800001",
        "complete" : true,
        "created_at" : "2013-01-23T19:06:16.328Z",
        "cue_points" : [ {
        "name" : "Flying Off",
        "type" : "CODE",
        "time" : 2.64,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        }, {
        "name" : "Pre-roll",
        "type" : "AD",
        "time" : 0.0,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        }, {
        "name" : "Bird Back",
        "type" : "CODE",
        "time" : 5.938,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        }, ...
        
        

    GET sources

    Retrieve the sources for a specific video.

    Endpoint: /videos/{video_id}/sources

    Request

        https://cms.api.brightcove.com/v1/accounts/1507807800001/videos/2114345471001/sources
        
        

    Response

        [
        {
        "asset_id": "5164827527001",
        "remote": false,
        "src": "http://brightcove.vo.llnwd.net/e2/hls/57838016001/57838016001_5164827527001_5164799982001.m3u8?pubId=57838016001&videoId=5164799982001",
        "type": "application/vnd.apple.mpegurl"
        },
        {
        "asset_id": "5164827527001",
        "remote": false,
        "src": "https://brightcove.hs.llnwd.net/e2/hls/57838016001/57838016001_5164827527001_5164799982001.m3u8?pubId=57838016001&videoId=5164799982001",
        "type": "application/vnd.apple.mpegurl"
        }, ...
        ]
        
        

    GET images

    Retrieve the images for a specific video.

    Endpoint: /videos/{video_id}/images

    Request

        https://cms.api.brightcove.com/v1/accounts/1507807800001/videos/2114345471001/images
        
        

    Response

        {
        "thumbnail" : {
        "id" : "3815806023001",
        "src" : "http://brightcove.vo.llnwd.net/v1/unsecured/media/1507807800001/201410/2431/1507807800001_3815806023001_thumb.jpg?pubId=1507807800001"
        },
        "poster" : {
        "id" : "3815782921001",
        "src" : "http://brightcove.vo.llnwd.net/v1/unsecured/media/1507807800001/201410/273/1507807800001_3815782921001_still.jpg?pubId=1507807800001"
        }
        }
        
        

    GET video by refid

    Retrieve the data for a specific video using the reference id.

    Endpoint: /videos/ref:{video_reference_id}

    Request

        https://cms.api.brightcove.com/v1/accounts/1507807800001/videos/ref:titmouse_title_refid7
        
        

    Response

        {
        "id" : "2114345471001",
        "account_id" : "1507807800001",
        "complete" : true,
        "created_at" : "2013-01-23T19:06:16.328Z",
        "cue_points" : [ {
        "name" : "Flying Off",
        "type" : "CODE",
        "time" : 2.64,
        "metadata" : null,
        "force_stop" : false,
        "asset_id" : null
        }, ...
        
        

    GET sources by refid

    Retrieve the sources for a specific video using its reference id.

    Endpoint: /videos/ref:{video_reference_id}/sources

    Request

        https://cms.api.brightcove.com/v1/accounts/1507807800001/videos/ref:titmouse_title_refid7/sources
        
        

    Response

        [
        {
        "asset_id": "5192219618001",
        "remote": false,
        "src": "http://brightcove.vo.llnwd.net/v1/uds/pd/57838016001/201611/3753/57838016001_5192219618001_5192207668001.mp4?pubId=57838016001&videoId=5192207668001",
        "codec": "H264",
        "container": "MP4",
        "encoding_rate": 1823000,
        "duration": 41237,
        "height": 540,
        "width": 960,
        "size": 9417086,
        "uploaded_at": "2016-11-01T09:37:37.336Z"
        },
        {
        "asset_id": "5192219618001",
        "remote": false,
        "src": "https://brightcove.hs.llnwd.net/v1/uds/pd/57838016001/201611/3753/57838016001_5192219618001_5192207668001.mp4?pubId=57838016001&videoId=5192207668001",
        "codec": "H264",
        "container": "MP4",
        "encoding_rate": 1823000,
        "duration": 41237,
        "height": 540,
        "width": 960,
        "size": 9417086,
        "uploaded_at": "2016-11-01T09:37:37.336Z"
        }, ...
        ]
        
        

    GET images by refid

    Retrieve the images for a specific video using its reference id.

    Endpoint: /videos/ref:{video_reference_id}/images

    Request

        https://cms.api.brightcove.com/v1/accounts/1507807800001/videos/ref:titmouse_title_refid7/images
        
        

    Response

        {
        "thumbnail" : {
        "id" : "3815806023001",
        "src" : "http://brightcove.vo.llnwd.net/v1/unsecured/media/1507807800001/201410/2431/1507807800001_3815806023001_thumb.jpg?pubId=1507807800001"
        },
        "poster" : {
        "id" : "3815782921001",
        "src" : "http://brightcove.vo.llnwd.net/v1/unsecured/media/1507807800001/201410/273/1507807800001_3815782921001_still.jpg?pubId=1507807800001"
        }
        }
        
        

    Page last updated on 28 Sep 2020