Sign in

v50

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-2810050281.4 KB
Videos

Get Videos

Gets a page of video objects

get/v1/accounts/{{account_id}}/videos

Path parameters

account_idstring required

Video Cloud account ID.

Query parameters

limitinteger
Example:20

Number of items to return - see Paging Search Results for more information

offsetinteger
Example:20

Number of items to skip - see Paging Search Results for more information

sort'name' | '-name' | 'reference_id' | '-reference_id' | 'created_at' | '-created_at' | 'published_at' | '-published_at' | 'updated_at' | '-updated_at' | 'schedule.starts_at' | '-schedule.ends_at' | 'state' | '-state' | 'plays_total' | '-plays_total' | 'plays_trailing_week' | '-plays_trailing_week'
Example:created_at

Field to sort results by - if absent and there is a search string, results are sorted by relevance or if there is no search string, results are sorted by -updated_at. Notes:

  • to sort in descending order, preface the field name with a minus (-) sign
  • this parameter can be used to sort results both for a get videos request and for a get videos in folder request
qstring
Example:+name:Birds

Search string - see search guide for details

querystring
Example:+name:Birds

Search string - see search guide for details

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Response

200

ad_keysstring nullable

string representing the ad key/value pairs assigned to the video. Key/value pairs are formatted as key=value and are separated by ampersands - can only be added on update, not creation

clip_source_video_idstring

The ID of the source video that was clipped to produce this video or null if this video is not a clip of another video

completeboolean

whether the video has at least one rendition -Note: when you create a new video, the complete property is automatically set to false. As soon as one rendition exists for the video, the complete property will be automatically set to true. This does not mean that all renditions are created and images and captions processed. For the full status of ingestion, see Dynamic Ingest API Notifications

created_atstring

when the video was created

custom_fieldsobject
delivery_type'remote' | 'dynamic_origin' | 'live_origin' | 'unknown'

video delivery type:

  • remote: a remote asset
  • dynamic_origin: processed using the Dynamic Delivery ingest system
  • live_origin: a live stream from Brightcove Live
  • unknown: the delivery type could not be determined (may mean there are no playable renditions)
descriptionstring

video short description

digital_master_idstring

asset id of the digital master

drm_disabledboolean

if true, the video is not DRM-packaged - applies to accounts that are enabled for DRM only

durationinteger

video duration in milliseconds

economics'AD_SUPPORTED' | 'FREE'

whether video is AD_SUPPORTED

folder_idstring

id of the folder that contains the video

forensic_watermarking'ACTIVE' | 'UNAVAILABLE'

Indicates whether the video has forensic watermarking

possible values:

  • ACTIVE - the video was transcoded with forensic watermarking and should be used during delivery
  • UNAVAILABLE - the video was not transcoded with forensic watermarking support and can’t be delivered using it
  • null - the value is for forensic watermarking is not available for the account; in this case the field is not returned in API responses

if the video was not ingested with forensic watermarking, this field will be set to UNAVAILABLE automatically; if the video was ingested or retranscoded with forensic watermarking, this field will be set to ACTIVE automatically

has_digital_masterboolean

whether video has an archived master than can be used for retranscoding

idstring

video id

imagesVideoImages

map of image maps - the map name is in the form label.language where the label is one of poster, thumbnail, portrait, square, wide or ultra-wide, and the language is a language identifier such as 'en', 'de', or ko

labelsstring[]

Array of labels assigned to the video. See Working with Labels for more information.

long_descriptionstring

video long description - can only be added on update, not creation

namestring

video title

offline_enabledboolean

whether video is enabled for offline viewing

original_filenamestring

the original file name for the uploaded video

playback_rights_idstring

Associates specified EPA playback rights with video.

projection'equirectangular' nullable

used for 360 videos

published_atstring

start date-time of first activation in ISO-8601(https://www.ecma-international.org/ecma-262/5.1/#sec-15.9.1.15) format

reference_idstring nullable

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

state'ACTIVE' | 'INACTIVE' | 'PENDING' | 'DELETED'

The state of the video:

  • ACTIVE: the video is playable
  • INACTIVE: the video is not playable
  • PENDING:
  • DELETED: the video has been deleted (within the past 10 days; after that, the API won't return the video)
tagsstring[]

array of tags - maximum characters per tag is 1000

updated_atstring

when the video was last modified

Example response

[
  {
    "ad_keys": " \"adKeys\": \"category=sports&live=true\"",
    "complete": true,
    "created_at": "2015-09-17T16:08:37.108Z",
    "cue_points": [
      {
        "time": 10.527
      }
    ],
    "delivery_type": "dynamic_origin",
    "description": "Herring gull on a wharf in Boston",
    "drm_disabled": true,
    "duration": 18160,
    "economics": "AD_SUPPORTED",
    "folder_id": "560039e5e4b0e69e4b01cacd",
    "forensic_watermarking": "ACTIVE",
    "geo": {
      "countries": [
        "us",
        "ca",
        "fr"
      ]
    },
    "has_digital_master": true,
    "images": {
      "thumbnail": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/main/160x90/20s629ms/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/main/160x90/20s629ms/match/image.jpg",
            "height": 90,
            "width": 160
          }
        ]
      },
      "poster": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/main/1280x720/20s629ms/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/main/1280x720/20s629ms/match/image.jpg",
            "height": 720,
            "width": 1280
          }
        ]
      },
      "portrait.es": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/bac8717a-43db-4fa8-a6f0-189c80ee4c4e/800x1200/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/bac8717a-43db-4fa8-a6f0-189c80ee4c4e/800x1200/match/image.jpg",
            "height": 1200,
            "width": 800
          }
        ]
      },
      "thumbnail.en": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/0ce2da4d-ca36-469b-9024-0273d79feeeb/292x108/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/0ce2da4d-ca36-469b-9024-0273d79feeeb/292x108/match/image.jpg",
            "height": 108,
            "width": 292
          }
        ]
      },
      "poster.en": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/a7cb150d-c84a-48e0-9469-5b4ce80fba53/1920x1080/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/a7cb150d-c84a-48e0-9469-5b4ce80fba53/1920x1080/match/image.jpg",
            "height": 1080,
            "width": 1920
          }
        ]
      },
      "square.de": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/22209955-e136-4f17-914c-e19ec4c58886/570x570/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/22209955-e136-4f17-914c-e19ec4c58886/570x570/match/image.jpg",
            "height": 570,
            "width": 570
          }
        ]
      },
      "ultra-wide.hi": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/72fd489f-d978-44ba-8d04-1e33c7c36cef/3840x1646/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/72fd489f-d978-44ba-8d04-1e33c7c36cef/3840x1646/match/image.jpg",
            "height": 1646,
            "width": 3840
          }
        ]
      },
      "wide.fr": {
        "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/4405a5d5-8b9e-4c2b-be71-cf4e2c153e87/2560x1440/match/image.jpg",
        "sources": [
          {
            "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/static/57838016001/ee705e97-3fb5-409c-99d8-703e9f57bd0a/4405a5d5-8b9e-4c2b-be71-cf4e2c153e87/2560x1440/match/image.jpg",
            "height": 1440,
            "width": 2560
          }
        ]
      }
    },
    "long_description": "Herring Gull near Fort Point Channel in Boston, MA, USA. 2019-04-25.",
    "name": "Laughing Gull",
    "offline_enabled": true,
    "original_filename": "gull-boston.mov",
    "projection": "equirectangular",
    "published_at": "2019-04-30T23:27:22.507Z",
    "reference_id": "laughing_gull_2019_04_25",
    "schedule": {
      "ends_at": "2020-05-20T20:41:07.689Z",
      "starts_at": "2019-05-20T20:41:07.689Z"
    },
    "sharing": {
      "by_external_acct": true,
      "by_reference": true,
      "to_external_acct": true
    },
    "state": "ACTIVE",
    "tags": [
      "birds",
      "sea"
    ],
    "updated_at": "2018-02-27T19:09:20.401Z"
  }
]
All 100 operations