Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
Media

Single media objects/feeds

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

Supported response formats include JSON and various RSS types.

get/v2/media/{media_id}

Path parameters

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

max_resolution320 | 480 | 640 | 960 | 1280 | 1920

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.

format'json' | 'googledfp' | 'legacyrss' | 'mrss' | 'partner_rss' | 'roku_rss'

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 <a href="https://developer.roku.com/docs/specs/direct-publisher-feed-specs/mrss-dp-spec.md" target="_blank">Roku's Direct Publisher MRSS specification</a>"
default_source_fallbackboolean

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.

poster_width40 | 120 | 320 | 480 | 720 | 1280 | 1920

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
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.

sourcesstring[]

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.

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.

Response

A JSON object or RSS feed describing a media item including metadata, sources, and associated assets like tracks