Explicit SSAI Session Initialization Endpoint

post

https://cdn.jwplayer.com/v2/sites/{site_id}/media/{media_id}/ssai.{manifest_extension}

Initializes the SSAI session and returns a JSON with the URLs needed to stream content and track the session

If URL-signing is enabled, follow the instructions for creating a properly formed request.

For DRM-protected content, use the Single media, playback metadata endpoint and include the ad_config_id query parameter to request the SSAI version with DRM support.

Path Params

site_id

string

required

Property or site ID that owns a piece of media

media_id

string

required

Eight-character, alphanumeric ID that uniquely identifies the media

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

manifest_extension

string

enum

required

The file extension of the manifest

Possible values:

m3u8: HLS manifest
mpd: DASH manifest

Allowed:

Query Params

ad_config_id

string

required

Unique identifier of the ad config

schema

string

enum

(Optional) Schema format for the requested SSAI media manifest

The schema query parameter is either omitted/empty or aws. When empty, successful JSON uses manifest_url and session_info. When schema=aws, the same values are returned as manifestUrl and trackingUrl.

Allowed:

Body Params

reporting_mode

string

Indicates whether tracking beacons are sent by the client or the server
To request an AWS schema, this value must be passed as 'reportingMode' (in camelCase).
This value is passed through to the 'session_info' or 'trackingUrl' URL as a query parameter.

Possible values:

'client': (Default) The player or client sends tracking beacons
'server': The server sends tracking beacons

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200SSAI session started successfully. JSON containing the manifest URL and session info URL. May include an optional warning when playback URLs are still returned but something did not match the ideal path.

400Bad Request The request either lacks certain attributes or contains malformed/invalid attributes. When session initialization cannot proceed due to a client-side problem, the body may be JSON with code and description.

404Not Found The requested asset could not be found. The response body may include a JSON object with code and description explaining the issue.

422Unprocessable Content The requested extension could not be processed. When session initialization cannot complete, the response body may include a JSON object with code and description explaining the issue.