Platform DocsPlayers DocsRelease Notes
API Reference
System StatusSubmit a CaseDashboard LoginCompany Site

Get a single media object with an external ID

get
https://cdn.jwplayer.com/v2/site//media/ext:

Uses the external ID of a media to return all metadata and assets (images, tracks, conversions, manifests) associated with the media

Various formats are supported including JSON and various RSS types.

For media with a renditions hosting type (CMAF VOD), the thumbnails track is served at /v2/sites/{site_id}/media/{media_id}/thumbstrip.vtt rather than the /strips/{media_id}-120.vtt shown in the examples below.

Path Params
string
required

Property or site ID that owns a piece of media

string
required

External ID defined within a piece of media

Query Params
integer
enum

Specifies the maximum allowed width and height for renditions.

Only renditions with both dimensions less than or equal to the provided value are included.

Possible Values:

  • 320
  • 480
  • 640
  • 960
  • 1280
  • 1920

This is currently only supported for use with HLS streams.

Allowed:
string
enum

The output template format

Possible values:

  • json: (Default) Provides an easy format for integrations on your site and is natively consumed by JWX
  • googledfp: Aligns with the Google MRSS feed specification for Ad Manager integration
  • legacyrss: Provides backward compatibility for an older RSS format previously served by JWX
  • mrss: Aligns with the Media RSS specification. Optimized for playback in the JWX web player. Recommended for use with JWX's FAST Channels partnership integration
  • partner_rss: Aligns with the MRSS specifications of content syndicators, e.g. MSN and Verizon Media. This format is not optimized for playback and does not include JWX Custom Parameters
  • roku_rss: Aligns with the Roku's Direct Publisher MRSS specification"
Allowed:
boolean

Whether to provide a fallback if the requested source qualities do not exist

Default behavior is false.

When this parameter is true, the playlist will be populated with the next valid rendition, if one exists.

Use of this parameter is not recommended, but it is available to provide similar behavior to legacy feed generation logic.

integer
enum

The width of poster images to include with the playlist

By default, the playlist will include 720-pixel-wide images which is a good balance between quality and page speed for most playlist thumbnail applications.

Possible values:

  • 40
  • 120
  • 320
  • 480
  • 720
  • 1280
  • 1920
Allowed:
string

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.

sources
array of strings

The media sources included in the playlist

This is a comma-separated list of values in the order in which they should appear in the playlist.

One can specify sources by adaptive streaming formats (dash, hls), quality levels (ex: 1080p, 720p, 1920px), or legacy template IDs.

Note that mixing the way the sources are specified may have unexpected results.

sources
string

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.

Headers
string
enum
Defaults to application/json; charset=utf-8

Generated from available response content types

Allowed:
Responses

403

Access is Forbidden

This error commonly occurs when a user either does not have a token or uses an invalid token to request an asset that requires URL signing. It may also occur due to geoblocking, account suspension, deletion, or limits reached.

404

Not Found

The requested asset could not be found.

Updated 4 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8
feed_instance_id
title
kind
playlist
description

Updated 4 days ago

Did this page help you?
© 2007- Longtail Ad Solutions, Inc.