Sign in

v10

latestOpenAPI 3.0.3raw.githubusercontent.com2023-03-2641141.5 KB
Videos

Get Video by ID or Reference ID

Gets a video object based on a 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

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.

BCOV-Policystring required

: {policy_key} (there are 3 ways to authenticate — use one of these three headers). You need to use a search-enabled Policy Key.

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 field name-value pairs

descriptionstring

video short description

durationnumber

video duration in milliseconds

economics'AD_SUPPORTED' | 'FREE'

whether video is AD_SUPPORTED

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

published_atstring

when the video was published

reference_idstring

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

tagsstring[]

array of tags

updated_atstring

when the video was last modified

ad_keysobject

map of key/value pairs for ad requests

Example response

[
  {
    "poster": "https://cf-images.eu-west-1.prod.boltdns.net/v1/jit/1752604059001/main/1280x720/11s436ms/match/image.jpg",
    "thumbnail": "https://cf-images.eu-west-1.prod.boltdns.net/v1/jit/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/main/160x90/11s436ms/match/image.jpg",
    "poster_sources": [
      {
        "src": "https://cf-images.eu-west-1.prod.boltdns.net/v1/jit/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/main/1280x720/11s436ms/match/image.jpg"
      }
    ],
    "thumbnail_sources": [
      {
        "src": "https://cf-images.eu-west-1.prod.boltdns.net/v1/jit/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/main/160x90/11s436ms/match/image.jpg"
      }
    ],
    "description": "Panoramic view of the Rhine in the center of Basel, Switzerland.",
    "tags": [
      "basel"
    ],
    "cue_points": [],
    "custom_fields": {},
    "account_id": "1752604059001",
    "sources": [
      {
        "ext_x_version": "4",
        "src": "https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/10s/master.m3u8?fastly_token=NWZmYzdkYzJfM2NkZDFkZTYxOWFjM2VhYmQwOGUzOWQ4YjAwNzQyZmJkMTRhYTI0ZmE3MDA2YTM3M2E4NzJjMDFmNWViNDgyZA%3D%3D",
        "type": "application/x-mpegURL"
      },
      {
        "ext_x_version": "4",
        "src": "https://manifest.prod.boltdns.net/manifest/v1/hls/v4/clear/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/10s/master.m3u8?fastly_token=NWZmYzdkYzJfM2NkZDFkZTYxOWFjM2VhYmQwOGUzOWQ4YjAwNzQyZmJkMTRhYTI0ZmE3MDA2YTM3M2E4NzJjMDFmNWViNDgyZA%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/c1303d3e-c9b2-433d-9b96-74ae1f086834/10s/master.m3u8?fastly_token=NWZmYzdkYzJfZDhlN2M3OTNmMGI2YTc2ZGVmYWQ4NDEwNDljZmQ0YjFiNzE3ZDljMjM5MTA0YTczN2NlYmQ3MzEyODM4MzRjOA%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/c1303d3e-c9b2-433d-9b96-74ae1f086834/10s/master.m3u8?fastly_token=NWZmYzdkYzJfZDhlN2M3OTNmMGI2YTc2ZGVmYWQ4NDEwNDljZmQ0YjFiNzE3ZDljMjM5MTA0YTczN2NlYmQ3MzEyODM4MzRjOA%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/c1303d3e-c9b2-433d-9b96-74ae1f086834/2s/manifest.mpd?fastly_token=NWZmYzdkYzJfZGRkMGNiZjNjNGQzNDcyNDg0Y2MzODc1ZDMzYjYwN2IyNDMxNWIwNzY1OTFlNzE3NzU5MzEyNGUyMWYyYzc2MA%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/c1303d3e-c9b2-433d-9b96-74ae1f086834/2s/manifest.mpd?fastly_token=NWZmYzdkYzJfZGRkMGNiZjNjNGQzNDcyNDg0Y2MzODc1ZDMzYjYwN2IyNDMxNWIwNzY1OTFlNzE3NzU5MzEyNGUyMWYyYzc2MA%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/c1303d3e-c9b2-433d-9b96-74ae1f086834/2s/manifest.mpd?fastly_token=NWZmYzdkYzJfNjJkZWM5NjE0MDViZmFjMTI1YmE4NjU3ZGRlM2I1ZjUwOTA5MTNlNzg2YmM2ZTFhYzkwYjk1MDEyZjk5ZGI1YQ%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/c1303d3e-c9b2-433d-9b96-74ae1f086834/2s/manifest.mpd?fastly_token=NWZmYzdkYzJfNjJkZWM5NjE0MDViZmFjMTI1YmE4NjU3ZGRlM2I1ZjUwOTA5MTNlNzg2YmM2ZTFhYzkwYjk1MDEyZjk5ZGI1YQ%3D%3D",
        "type": "application/dash+xml"
      },
      {
        "avg_bitrate": 2075000,
        "codec": "H264",
        "container": "MP4",
        "duration": 22870,
        "height": 720,
        "size": 5930479,
        "src": "https://bcboltbde696aa-a.akamaihd.net/media/v1/pmp4/static/clear/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/9608379b-6710-4f39-ac63-602f68bc2ff3/main.mp4?akamai_token=exp=1610382786~acl=/media/v1/pmp4/static/clear/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/9608379b-6710-4f39-ac63-602f68bc2ff3/main.mp4*~hmac=54a20d631aabdb4712cdf5eb6638c763d1a2f503ab63cfd2d2c8146c9adee4d9",
        "width": 1280
      },
      {
        "avg_bitrate": 2075000,
        "codec": "H264",
        "container": "MP4",
        "duration": 22870,
        "height": 720,
        "size": 5930479,
        "src": "https://bcboltbde696aa-a.akamaihd.net/media/v1/pmp4/static/clear/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/9608379b-6710-4f39-ac63-602f68bc2ff3/main.mp4?akamai_token=exp=1610382786~acl=/media/v1/pmp4/static/clear/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/9608379b-6710-4f39-ac63-602f68bc2ff3/main.mp4*~hmac=54a20d631aabdb4712cdf5eb6638c763d1a2f503ab63cfd2d2c8146c9adee4d9",
        "width": 1280
      }
    ],
    "name": "Basel: The Rhine - multi-lingual metadata",
    "reference_id": null,
    "long_description": null,
    "duration": 22872,
    "economics": "AD_SUPPORTED",
    "text_tracks": [
      {
        "id": null,
        "account_id": "1752604059001",
        "src": "https://manifest.prod.boltdns.net/thumbnail/v1/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/4193dd5b-db7b-42a9-960f-32888a498e42/thumbnail.webvtt?fastly_token=NWZmYzdkYzJfZWUxZGFjODFmZTE2ZmJkYmQ1MjAzNmE4ODNlMzRmNzdlMjM3ZjQzODJmNmM4YTdmYjBiYzg0NjU3Nzg4ZWIxYQ%3D%3D",
        "srclang": null,
        "label": "thumbnails",
        "kind": "metadata",
        "mime_type": "text/webvtt",
        "asset_id": null,
        "sources": null,
        "default": false,
        "width": 320,
        "height": 180,
        "bandwidth": 243
      },
      {
        "id": null,
        "account_id": "1752604059001",
        "src": "https://manifest.prod.boltdns.net/thumbnail/v1/1752604059001/c1303d3e-c9b2-433d-9b96-74ae1f086834/4193dd5b-db7b-42a9-960f-32888a498e42/thumbnail.webvtt?fastly_token=NWZmYzdkYzJfZWUxZGFjODFmZTE2ZmJkYmQ1MjAzNmE4ODNlMzRmNzdlMjM3ZjQzODJmNmM4YTdmYjBiYzg0NjU3Nzg4ZWIxYQ%3D%3D",
        "srclang": null,
        "label": "thumbnails",
        "kind": "metadata",
        "mime_type": "text/webvtt",
        "asset_id": null,
        "sources": null,
        "default": false,
        "width": 320,
        "height": 180,
        "bandwidth": 243
      }
    ],
    "published_at": "2019-04-16T18:04:20.746Z",
    "created_at": "2019-04-16T18:04:20.731Z",
    "updated_at": "2020-12-14T16:06:02.693Z",
    "offline_enabled": false,
    "link": null,
    "id": "6026822730001",
    "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"
        }
      }
    ]
  }
]