v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
Media
DRM Media

Single media, playback metadata endpoint

Returns all metadata and assets necessary for media playback in a JWX player, such as images, tracks, conversions, and manifests.

This endpoint serves both non-DRM and DRM-protected content. For DRM-protected content, the request must include both a JWT and the drm_policy_id parameter.

See Playlists for more information on how to use this route for playback in a JWX player.

Response format is JSON only.

get/v2/sites/{site_id}/media/{media_id}/playback.json

Path parameters

site_idstring required

Property or site ID that owns a piece of media

media_idstring required

Eight-character, alphanumeric ID that uniquely identifies the media

This can be found on the video detail page in the dashboard.

Query parameters

recommendations_playlist_idstring

Eight-character, alphanumeric ID (ex: wZuMVmMk) that uniquely identifies the recommendations playlist to use

If no recommendations_playlist_id is included, the playlist will use the default recommendations 'similar video' playlist for the property.

tokenstring

Signature for requests to the Content API for protected content

It consists of a JSON Web Token (JWT) containing the parameters of the request.

When requested with no signature to prevent unauthorized access to videos, unsigned video URLs are returned.

More information is available in the developer guide.

drm_policy_idstring

Eight-character, alphanumeric ID (ex: b2Afe1zG) uniquely identifying the DRM policy to apply

If this is not included on a DRM-protected media request, the request is considered invalid. It must also be included as a parameter when generating the required JWT for DRM requests.

ad_config_idstring

Unique identifier of the ad config

Response

A JSON object describing the media item. It includes metadata, sources, and associated assets such as tracks. If the media item has custom parameters, they will be included at the playlist item level. For metadata such as title, description, duration, and tags, the custom parameter value will take precedence.