latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-15101266.2 KB

c8653db137ef

Videos

Get Video by ID or Reference ID

Gets a video object based on a video ID or reference ID. To get a video using the reference_id, use: https://edge.api.brightcove.com/playback/v1/accounts/{{account_id}}/videos/ref:{reference_id}`

Note that you can specify only one video id or `reference_id.

get/accounts/{{account_id}}/videos/{{video_id}}

Path parameters

account_idstring required

Video Cloud account ID

video_idstring required

Video Cloud video ID

Query parameters

ad_config_idstring

include server-side ad insertion

config_idstring

include and set equal to the delivery rules id in order to have the delivery rules applied

Headers

Authorizationstring required

BCOV-Policy {policy_key} (there are 3 ways to authenticate — use one of these three headers). You need to use a search-enabled Policy Key if you are using the q parameter.

BCOV-Policystring required

BCOV-Policy {policy_key} (there are 3 ways to authenticate — use one of these three headers). You need to use a search-enabled Policy Key if you are using the q parameter.

Acceptstring required

application/json;pk=policy_key (there are 3 ways to authenticate — use one of these three headers) See Policy API Overview or Policy Keys for information on getting policy keys

Response

200

idstring

video id

namestring

video title

created_atstring

when the video was created

custom_fieldsobject

map of fieldname-value pairs

descriptionstring

video short description

durationnumber

video duration in milliseconds

economics'AD_SUPPORTED' | 'FREE'

whether video is AD_SUPPORTED

playback_rights_idstring

Associates specified EPA playback rights with video.

posterstring

URL for the default poster source image

projectionstring

The mapping projection for 360° videos, e.g. "equirectangular"

thumbnailstring

URL for the default thumbnail source image

long_descriptionstring

video long description

offline_enabledboolean

whether video is enabled for offline viewing

reference_idstring

video reference-id (must be unique within the account)

tagsstring[]

array of tags

transcriptsTranscription[] — unresolved $ref

array of transcription objects - can only be added on update, not creation

updated_atstring

when the video was last modified

ad_keysobject

map of key/value pairs for ad requests

Example response

{
  "poster": "https://httpsak-a.akamaihd.net/1752604059001/1752604059001_4883205209001_4883184247001-vs.jpg?pubId=1752604059001&videoId=4883184247001",
  "thumbnail": "https://httpsak-a.akamaihd.net/1752604059001/1752604059001_4883205207001_4883184247001-th.jpg?pubId=1752604059001&videoId=4883184247001",
  "poster_sources": [
    {
      "src": "https://httpsak-a.akamaihd.net/1752604059001/1752604059001_4883205209001_4883184247001-vs.jpg?pubId=1752604059001&videoId=4883184247001"
    }
  ],
  "thumbnail_sources": [
    {
      "src": "https://httpsak-a.akamaihd.net/1752604059001/1752604059001_4883205207001_4883184247001-th.jpg?pubId=1752604059001&videoId=4883184247001"
    }
  ],
  "description": null,
  "tags": [
    "public",
    "sample",
    "water"
  ],
  "cue_points": [],
  "custom_fields": {
    "customfield1": "foo",
    "customfield2": "bar"
  },
  "account_id": "1752604059001",
  "sources": [
    {
      "ext_x_version": "4",
      "src": "https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/10s/master.m3u8?fastly_token=NWZiNDMxZWFfZGZkYjE0MTc1MmQyYTQ5YmMzMTY3MzM0OGZlMzVjNjYwOTNjYzY1MDUxNDA4YjJhYjU1MjU2YjFiMWZkZWI0MQ%3D%3D",
      "type": "application/x-mpegURL"
    },
    {
      "ext_x_version": "4",
      "src": "https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/10s/master.m3u8?fastly_token=NWZiNDMxZWFfZGZkYjE0MTc1MmQyYTQ5YmMzMTY3MzM0OGZlMzVjNjYwOTNjYzY1MDUxNDA4YjJhYjU1MjU2YjFiMWZkZWI0MQ%3D%3D",
      "type": "application/x-mpegURL"
    },
    {
      "codecs": "avc1,mp4a",
      "ext_x_version": "7",
      "src": "https://manifest.prod.boltdns.net/manifest/v2/hls/v7/clear/avc1_mp4a/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/10s/master.m3u8?fastly_token=NWZiNDMxZWFfYTcwYTY3ZmZjN2I1NTFlYWFhNmI2M2ZlNGE2MDE2ZjNjYmJkZDE0YzBiZjc0MzNmMWYxZmQ0OTQ4MWVmMmVmNQ%3D%3D",
      "type": "application/x-mpegURL"
    },
    {
      "codecs": "avc1,mp4a",
      "ext_x_version": "7",
      "src": "https://manifest.prod.boltdns.net/manifest/v2/hls/v7/clear/avc1_mp4a/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/10s/master.m3u8?fastly_token=NWZiNDMxZWFfYTcwYTY3ZmZjN2I1NTFlYWFhNmI2M2ZlNGE2MDE2ZjNjYmJkZDE0YzBiZjc0MzNmMWYxZmQ0OTQ4MWVmMmVmNQ%3D%3D",
      "type": "application/x-mpegURL"
    },
    {
      "profiles": "urn:mpeg:dash:profile:isoff-live:2011",
      "src": "https://manifest.prod.boltdns.net/manifest/v1/dash/live-baseurl/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/2s/manifest.mpd?fastly_token=NWZiNDMxZWFfZWZmYTk5MjkxZmU1MzI2OTk4ZWRjNmZlNzU2ZDRiZmYxMTU5YmFkZTE4ZDJhN2E1YTVjYTY1NTBlNjdiMDdiNg%3D%3D",
      "type": "application/dash+xml"
    },
    {
      "profiles": "urn:mpeg:dash:profile:isoff-live:2011",
      "src": "https://manifest.prod.boltdns.net/manifest/v1/dash/live-baseurl/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/2s/manifest.mpd?fastly_token=NWZiNDMxZWFfZWZmYTk5MjkxZmU1MzI2OTk4ZWRjNmZlNzU2ZDRiZmYxMTU5YmFkZTE4ZDJhN2E1YTVjYTY1NTBlNjdiMDdiNg%3D%3D",
      "type": "application/dash+xml"
    },
    {
      "codecs": "avc1,mp4a",
      "profiles": "urn:mpeg:dash:profile:isoff-live:2011",
      "src": "https://manifest.prod.boltdns.net/manifest/v2/dash/live-baseurl/clear/avc1_mp4a/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/2s/manifest.mpd?fastly_token=NWZiNDMxZWFfOTRmMjg4MDdjNDYxNzhiNDBkMWU3ZWU4M2ZiMjc5MzFmODBiMDYwMGUyYjk2YWU1NDFhZmNiYzgzNWY2MTIwMw%3D%3D",
      "type": "application/dash+xml"
    },
    {
      "codecs": "avc1,mp4a",
      "profiles": "urn:mpeg:dash:profile:isoff-live:2011",
      "src": "https://manifest.prod.boltdns.net/manifest/v2/dash/live-baseurl/clear/avc1_mp4a/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/2s/manifest.mpd?fastly_token=NWZiNDMxZWFfOTRmMjg4MDdjNDYxNzhiNDBkMWU3ZWU4M2ZiMjc5MzFmODBiMDYwMGUyYjk2YWU1NDFhZmNiYzgzNWY2MTIwMw%3D%3D",
      "type": "application/dash+xml"
    },
    {
      "avg_bitrate": 2213000,
      "codec": "H264",
      "container": "MP4",
      "duration": 49690,
      "height": 1080,
      "size": 13753809,
      "src": "https://bcboltbde696aa-a.akamaihd.net/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/high.mp4?akamai_token=exp=1605644778~acl=/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/high.mp4*~hmac=962808a9a0bb0d1bba5d67a0dc24a9cf078f589545c50f777a2e637ad25e9e08",
      "width": 1920
    },
    {
      "avg_bitrate": 2213000,
      "codec": "H264",
      "container": "MP4",
      "duration": 49690,
      "height": 1080,
      "size": 13753809,
      "src": "https://bcboltbde696aa-a.akamaihd.net/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/high.mp4?akamai_token=exp=1605644778~acl=/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/high.mp4*~hmac=962808a9a0bb0d1bba5d67a0dc24a9cf078f589545c50f777a2e637ad25e9e08",
      "width": 1920
    },
    {
      "avg_bitrate": 613000,
      "codec": "H264",
      "container": "MP4",
      "duration": 49690,
      "height": 1080,
      "size": 3826436,
      "src": "https://bcboltbde696aa-a.akamaihd.net/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/mid.mp4?akamai_token=exp=1605644778~acl=/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/mid.mp4*~hmac=71eb21be1beb5712512991f18a1f94d62e00fafbe46697024b0022099c737aad",
      "width": 1920
    },
    {
      "avg_bitrate": 613000,
      "codec": "H264",
      "container": "MP4",
      "duration": 49690,
      "height": 1080,
      "size": 3826436,
      "src": "https://bcboltbde696aa-a.akamaihd.net/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/mid.mp4?akamai_token=exp=1605644778~acl=/media/v1/pmp4/static/clear/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/mid.mp4*~hmac=71eb21be1beb5712512991f18a1f94d62e00fafbe46697024b0022099c737aad",
      "width": 1920
    }
  ],
  "name": "Canada Geese and Goslings",
  "reference_id": null,
  "long_description": null,
  "duration": 49633,
  "economics": "AD_SUPPORTED",
  "text_tracks": [
    {
      "id": null,
      "account_id": "1752604059001",
      "src": "https://manifest.prod.boltdns.net/thumbnail/v1/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/2160be82-a59b-4382-a0a7-244b6de2e0fc/thumbnail.webvtt?fastly_token=NWZiNDMxZWFfNDA2Yzg0NDAyNjg4N2MzMmUyNjBiNmY2NWY5YzExN2RhNzdmNDAyNzZjYzA1ODk0MjI5OTRmMzcxNjcxMjhhOQ%3D%3D",
      "srclang": null,
      "label": "thumbnails",
      "kind": "metadata",
      "mime_type": "text/webvtt",
      "asset_id": null,
      "sources": null,
      "default": false,
      "width": 192,
      "height": 108,
      "bandwidth": 360
    },
    {
      "id": null,
      "account_id": "1752604059001",
      "src": "https://manifest.prod.boltdns.net/thumbnail/v1/1752604059001/59b8dae1-5de8-4f8c-8f67-52a4eac73b70/2160be82-a59b-4382-a0a7-244b6de2e0fc/thumbnail.webvtt?fastly_token=NWZiNDMxZWFfNDA2Yzg0NDAyNjg4N2MzMmUyNjBiNmY2NWY5YzExN2RhNzdmNDAyNzZjYzA1ODk0MjI5OTRmMzcxNjcxMjhhOQ%3D%3D",
      "srclang": null,
      "label": "thumbnails",
      "kind": "metadata",
      "mime_type": "text/webvtt",
      "asset_id": null,
      "sources": null,
      "default": false,
      "width": 192,
      "height": 108,
      "bandwidth": 360
    }
  ],
  "transcripts": [
    {
      "default": false,
      "id": "d5967d03-1de1-a2de-47db-73496c7474c1",
      "account_id": "12345678910",
      "label": "Irish English",
      "src": "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10",
      "src_lang": "en-IE",
      "status": "draft",
      "sources": [
        "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10",
        "https://bcboltqause1-a.akamaihd.net/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt?akamai_token=exp=1656544942~acl=/media/v1/text/txt/clear/12345678910/c6359761-86f7-70d6-4b98-f11f5bb98475/d5967d03-1de1-47db-a2de-774c3486c741/transcript.txt*~hmac=101a93fa0e0d247194de3c128460d457d4eea7a27d270a1f8509c2c00205af10"
      ]
    }
  ],
  "published_at": "2016-05-07T18:33:28.665Z",
  "created_at": "2016-05-07T18:33:28.665Z",
  "updated_at": "2020-04-25T19:50:54.934Z",
  "offline_enabled": false,
  "link": null,
  "id": "4883184247001",
  "ad_keys": null,
  "variants": [
    {
      "language": "de-DE",
      "name": "Basel: Der Rhein",
      "description": "Panoramablick auf den Rhein im Zentrum von Basel, Schweiz.",
      "long_description": "Panoramablick auf den Rhein im Zentrum von Basel, Schweiz.",
      "custom_fields": {}
    },
    {
      "language": "ja-JA",
      "name": "バーゼル:ライン川",
      "description": "スイス、バーゼルの中心部にあるライン川のパノラマビュー。",
      "long_description": "スイス、バーゼルの中心部にあるライン川のパノラマビュー。",
      "custom_fields": {
        "language": "Japanese"
      }
    }
  ]
}