GET Video Config by Video ID

Overview

---

The following table contains important information about the GET method for retrieving a video's player-independent configuration. Unlike the player-scoped variant, this endpoint does not require a playerId and returns the raw video configuration suitable for embedding the video without a specific player profile.

GET Video Config by Video ID
Method	GET
URL or Endpoint	/video/videoId.json
Headers	Authorization
Parameters	videoId
Body	Not Applicable

The description of the URL parameter is as follows:

URL Parameter Name	Mandatory	Type	Description
videoId	Yes	string	Unique Id of the video.

Request Body

The request does not contain a request body.

Response

{
  "videoId": "{videoId}",
  "file": "{file}",
  "title": "{title}",
  "description": "{description}",
  "publishDate": "{publishDate}",
  "publishEndDate": "{publishEndDate}",
  "thumbnail": "{thumbnail}",
  "filmstrip": "{filmstrip}",
  "filmstripVtt": "{filmstripVtt}",
  "private": false,
  "passwordProtected": false,
  "passwordProtectedTitle": "{passwordProtectedTitle}",
  "passwordProtectedDescription": "{passwordProtectedDescription}",
  "chapterState": false,
  "chapterPath": "{chapterPath}",
  "assetId": "{assetId}",
  "hasGeoRestriction": false,
  "geoRestrictionLink": "{geoRestrictionLink}",
  "hasDrm": false,
  "drmLicenseUrl": "{drmLicenseUrl}",
  "fpsCertificateUrl": "{fpsCertificateUrl}",
  "widevineLicenseUrl": "{widevineLicenseUrl}",
  "castContentType": "{castContentType}",
  "castVideoSource": "{castVideoSource}",
  "live": false,
  "liveType": "{liveType}",
  "maxLiveBackDuration": 0,
  "autoRelated": "{autoRelated}",
  "relatedVideos": "{relatedVideos}",
  "shareUrl": "{shareUrl}",
  "source": "{source}",
  "author": "{author}",
  "advertising": false,
  "showEngagementHeatmap": false,
  "adId": "{adId}",
  "startTime": 0,
  "tracks": [
    {
      "file": "{trackFile}",
      "lang": "{lang}",
      "label": "{label}"
    }
  ],
  "flags": [],
  "tags": [],
  "ads": {
    "type": "{type}",
    "isVmap": false,
    "enableProgrammability": false,
    "vmap": "{vmap}",
    "skipAllAds": false,
    "VPAIDmode": "{VPAIDmode}",
    "adBreaks": [],
    "bidding": false,
    "bidders": [],
    "functions": [],
    "enableDemandManager": false,
    "demandManager": null,
    "frequency": null,
    "maxCap": 0,
    "initialDelay": null,
    "adCycleDelayMs": null,
    "adRetryLimit": null,
    "adCycleRestartMs": null,
    "banner": null,
    "overrides": {
      "state": false,
      "prerollCount": -1,
      "cuepoints": null
    }
  },
  "playlist": {
    "state": false,
    "playlistId": "{playlistId}",
    "playlistVideoIndex": -1,
    "algorithm": "{algorithm}",
    "playlistDisplayType": "{playlistDisplayType}",
    "playlistBackupId": "{playlistBackupId}",
    "fromRecommended": false
  },
  "skipIntro": {
    "state": false,
    "skipFrom": null,
    "skipTo": null
  },
  "customOverlays": {
    "state": false,
    "overlays": []
  },
  "videoLocking": {
    "isEnabled": null,
    "value": null
  },
  "ageRestriction": {
    "isEnabled": null,
    "value": null
  },
  "videoProperties": []
}

If the action is successful, the service sends back an HTTP 200 response.

The description of the response fields is as follows:

Top-Level Properties

Field Name	Type	Description
videoId	string	Unique identifier of the video.
file	string	URL of the video file.
title	string	Title of the video.
description	string	Description of the video.
publishDate	string	Date and time when the video was published.
publishEndDate	string	Date and time when the video publish period ends.
thumbnail	string	URL of the video thumbnail image.
filmstrip	string	URL of the filmstrip image used for seek preview.
filmstripVtt	string	URL of the VTT file for filmstrip seek preview timing.
private	boolean	Whether the video is private.
passwordProtected	boolean	Whether the video is password protected.
passwordProtectedTitle	string	Title displayed on the password protection prompt.
passwordProtectedDescription	string	Description displayed on the password protection prompt.
chapterState	boolean	Whether chapters are enabled for the video.
chapterPath	string	URL of the chapter definitions file.
assetId	string	The content/asset identifier used for DRM.
hasGeoRestriction	boolean	Whether the video has geographic restrictions.
geoRestrictionLink	string	Redirect URL shown to geo-blocked users.
hasDrm	boolean	Whether DRM protection is enabled.
drmLicenseUrl	string	URL of the DRM license server.
fpsCertificateUrl	string	URL of the FairPlay Streaming certificate.
widevineLicenseUrl	string	URL of the Widevine DRM license server.
castContentType	string	MIME type used when casting the video.
castVideoSource	string	Video source URL used for casting.
live	boolean	Whether the video is a live stream.
liveType	string	Type of live stream.
maxLiveBackDuration	integer	Maximum duration in seconds for live DVR rewind.
autoRelated	string	Identifier for auto-generated related videos.
relatedVideos	string	Identifier for manually configured related videos.
shareUrl	string	URL used when sharing the video.
source	string	Source attribution for the video.
author	string	Author of the video.
advertising	boolean	Whether advertising is enabled for the video.
showEngagementHeatmap	boolean	Whether the engagement heatmap is displayed on the seek bar.
adId	string	Identifier of the ad schedule associated with the video.
startTime	integer	Start time offset in seconds for video playback.
tracks	array[object]	List of subtitle/caption tracks for the video.
flags	array[string]	List of flags associated with the video.
tags	array[string]	List of tags associated with the video.
ads	object	Ad configuration object for the video.
playlist	object	Playlist configuration if the video belongs to a playlist.
skipIntro	object	Skip intro configuration for the video.
customOverlays	object	Custom overlay configuration for the video.
videoLocking	object	Video locking configuration.
ageRestriction	object	Age-restriction gate configuration for the video.
videoProperties	array[object]	List of additional video properties.

tracks Properties

Field Name	Type	Description
file	string	URL of the subtitle/caption file.
lang	string	Language code of the track (e.g., "en", "de").
label	string	Display label of the track (e.g., "English").

ads Properties

Field Name	Type	Description
type	string	Type of ad configuration (e.g., DYNAMIC, STATIC).
isVmap	boolean	Whether the ad schedule uses VMAP format.
enableProgrammability	boolean	Whether ad programmability is enabled.
vmap	string	URL of the VMAP ad schedule.
skipAllAds	boolean	Whether all ads can be skipped.
VPAIDmode	string	VPAID rendering mode.
adBreaks	array[object]	List of ad break configurations.
bidding	boolean	Whether header bidding is enabled.
bidders	array[object]	List of header bidding bidder configurations.
functions	array[object]	List of ad macro function configurations.
enableDemandManager	boolean	Whether the demand manager (prebid) is enabled.
demandManager	object	Demand manager (prebid) configuration.
frequency	object	Ad frequency capping configuration.
maxCap	integer	Maximum number of ad impressions per frequency period.
initialDelay	object	Initial delay configuration before the first ad plays.
adCycleDelayMs	integer or null	Delay in milliseconds between ad cycles.
adRetryLimit	integer or null	Maximum number of ad request retries on failure.
adCycleRestartMs	integer or null	Time in milliseconds before an ad cycle restarts.
banner	object	Banner ad configuration.
overrides	object	Per-video ad overrides. When present, overrides the ad schedule's default midroll positioning with custom cue points and preroll count.

ads.overrides Properties

Field Name	Type	Description
state	boolean	Whether video-level ad overrides are active.
prerollCount	integer	The number of preroll ads to play for this video, overriding the ad schedule default. Defaults to -1 when no override is set.
cuepoints	array[integer]	List of custom midroll ad cue point times in seconds. Null when ad cue point overrides are not enabled.

playlist Properties

Field Name	Type	Description
state	boolean	Whether playlist mode is enabled.
playlistId	string	Unique identifier of the playlist.
playlistVideoIndex	integer	Index of the current video within the playlist.
algorithm	string	Algorithm used for playlist ordering.
playlistDisplayType	string	Display type of the playlist in the player UI.
playlistBackupId	string	Identifier of the backup playlist used if the primary playlist is unavailable.
fromRecommended	boolean	Whether the playlist is generated from recommendations.

skipIntro Properties

Field Name	Type	Description
state	boolean	Whether skip intro is enabled.
skipFrom	integer or null	Time in seconds when the skip intro button appears.
skipTo	integer or null	Time in seconds to skip to when the button is clicked.

customOverlays Properties

Field Name	Type	Description
state	boolean	Whether custom overlays are enabled.
overlays	array[object]	List of custom overlay configurations.

videoLocking Properties

Field Name	Type	Description
isEnabled	boolean or null	Whether video locking is enabled.
value	integer or null	Time in seconds after which the video is locked.

ageRestriction Properties

Field Name	Type	Description
isEnabled	boolean or null	Whether the age-restriction gate is enabled for the video.
value	integer or null	Minimum viewer age required to play the video. Set between 1 and 99 when isEnabled is true.

videoProperties Properties

Field Name	Type	Description
type	string	Type of the video property.
name	string	Name of the video property.

tip

For the player-scoped variant of this endpoint that also applies a specific player profile, see GET Video Config.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed