Playout API

List all available episodes

Media Jay Playout API (2025-08-04)

The playout API of the Media Jay application provides access to the playout data and orchestrates extended queries.

Authentication

To access the endpoints you require a X-API-Key in the header. Partners, please contact Transfermedia support@transfermedia.de to retrieve one.

Versioning

To use a specific implementation version of this API place it to the request header X-API-Version. If the header is missed the latest implementation version 2025-08-04 is used. The response header X-API-Version returns the implementation version the request was processed with.

Further documentation

For further details please visit the documentation or contact Transfermedia support@transfermedia.de.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Development Server

https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/

Session Tracking

APIs for managing user tracking sessions. These endpoints allow clients to create, retrieve, and delete tracking sessions which are used for analytics and user behavior tracking.

Operations

Formats

Access to formats metadata (aka movie collections or series).

Operations

Episodes

Access to episode metadata and general information.

Operations

List all available episodes

Request

Collects all episodes from the specified tenant's content library with optional filtering.

This endpoint retrieves episodes from the content repository based on the provided tenant ID and applies any specified filters. It performs a search against the playout exporter configurations to find matching episodes and verifies their availability in the storage.

The filtering system supports both exact matching and case-insensitive partial matching when the filter value is prefixed with a tilde (~).

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier) that determines which content repository to access. filter_provider: Filter for content provider name (e.g., "netflix", "hbo", "disney") filter_movie_or_series: Filter for movie or series name (e.g., "stranger_things") filter_episode: Filter for specific episode name (e.g., "pilot", "finale") filter_target_device: Filter for target playback device (e.g., "tv", "mobile", "web")

Returns:

ResultResponse[List[PlayoutEpisodeEntry]]: A Result Response contains list of episode entries matching the filter criteria, each containing metadata about the episode such as provider, series name, and target device.

Raises:

HTTPException: When authentication fails.

Path

playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform. This is typically provided by the service administrator.

Query

providerstring(provider filter)

Filter the episodes for a specific content provider (e.g., "netflix", "hbo"). Use exact match by default. Prepend a tilde ~ for a case insensitive text search (e.g., "~net" will match "Netflix").

movieOrSeriesstring(movie or series name)

Filter the episodes for a movie or series name (exact match, prepend a tilde ~ for a case insensitive text match).

episodestring(episode)

Filter the episodes for a episode name (exact match, prepend a tilde ~ for a case insensitive text match).

targetDevicestring(target device)

Filter the episodes for a target device name (exact match, prepend a tilde ~ for a case insensitive text match).

Headers

X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...

curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes?episode=string&movieOrSeries=string&provider=string&targetDevice=string' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved list of episodes with complete metadata

Bodyapplication/json

dataArray of objects(The response data)

The response data.

Example: [{"episodeId":"string","providerName":"string","movieOrSeriesName":"string","episodeName":"string","targetDeviceName":"string"}]

errorobject(The error response)

Represents a data response with a possible error.

Response

application/json

{
  "data": [
    { … }
  ]
}

Get episode details

Request

Get comprehensive details about a specific episode including title, description, duration, and associated group information.

This endpoint provides the foundation data needed to present an episode to viewers and provides access to its interactive components.

Args:

request: the complete request. playout_id: The playout identifier (aka tenant identifier).

episode_id: The episode identifier

inline_level: The number of levels to expand inner object inline.

Returns:

ResultResponse[PlayoutEpisode]: The Result response which contains the episode details.

Raises:

HTTPException: If the episode is not found (404) or descriptions are not available.

Path

playoutIdstring(playout identifier)required

The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform.

episodeIdstring(episode identifier)required

The episode identifier.

Query

inlineLevelinteger(inline level)[ 0 .. 4 ]

The number of levels to expand inner object inline. The lower this number the faster the response.

Default 0

Example: inlineLevel=1

Headers

X-API-Keystring(X-Api-Key)required

Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.

__Secure-jay_trackingstring( Secure-Jay Tracking)

Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.

Example: __Secure-jay_tracking=eyJzZX...

curl -i -X GET \
  'https://docs.jay-metadata.com/_mock/apis/playout/latest/openapi/playouts/{playoutId}/episodes/{episodeId}?inlineLevel=1' \
  -H 'X-API-Key: string' \
  -H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...'

Responses

Successfully retrieved episode details

Bodyapplication/json

dataobject(The response data)

Represents an episode

Example: {"title":"string","subtitle":"string","description":"string","custom1":"string","custom2":"string","custom3":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"language":"string","country":"string","characterCount":0,"actorCount":0,"locationCount":0,"costumeCount":0,"propCount":0,"ticketCount":0,"themeCount":0,"basicCount":0,"musicCount":0,"productCount":0,"groupCount":0,"mainGroupId":"string","mainGroup":{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"actorIds":["item"],"locationIds":["item"],"costumeIds":["item"],"productIds":["item"],"propIds":["item"],"ticketIds":["item"],"themeIds":["item"],"basicIds":["item"],"musicIds":["item"]},"groupIds":["item"],"groups":[{"id":"string","kind":"<<enum 'PlayoutKindType'>>","mainMenu":true,"name":"string","subtitle":"string","description":"string","images":[{"url":"string","copyright":"string"}],"links":[{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}],"layout":"string","groupIds":["item"],"groups":["item"],"characterIds":["item"],"actorIds":["item"],"locationIds":["item"],"costumeIds":["item"],"productIds":["item"],"propIds":["item"],"ticketIds":["item"],"themeIds":["item"],"basicIds":["item"],"musicIds":["item"]}]}

errorobject(The error response)

Represents a data response with a possible error.

Response

application/json

{
  "data": {
    "title": "string",
    "subtitle": "string",
    "description": "string",
    "custom1": "string",
    "custom2": "string",
    "custom3": "string",
    "images": [ … ],
    "links": [ … ],
    "language": "string",
    "country": "string",
    "characterCount": 0,
    "actorCount": 0,
    "locationCount": 0,
    "costumeCount": 0,
    "propCount": 0,
    "ticketCount": 0,
    "themeCount": 0,
    "basicCount": 0,
    "musicCount": 0,
    "productCount": 0,
    "groupCount": 0,
    "mainGroupId": "string",
    "mainGroup": { … },
    "groupIds": [ … ],
    "groups": [ … ]
  }
}

Episode items

Information about episode items.

Operations

Episode timeline

Information about timeline events with complete timing information.

Operations

Episode groups

Information about existing groups.

Operations

Episode scenes

Information about the scenes.

Operations

Episode companies involved

Information about the involved companies.

Operations

API information

Operations

Media Jay Playout API (2025-08-04)

Authentication

Versioning

Further documentation

Session Tracking

Formats

Episodes

List all available episodes

Request

Responses

Was this helpful?

Get episode details

Request

Responses

Was this helpful?

Episode items

Episode timeline

Episode groups

Episode scenes

Episode companies involved

API information