# Get episode details 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. Endpoint: GET /playouts/{playoutId}/episodes/{episodeId} Version: 2025-09-02 ## Path parameters: - `playoutId` (string, required) The playout identifier (aka tenant identifier) addressing the correct content of the streaming platform. - `episodeId` (string, required) The episode identifier. ## Query parameters: - `inlineLevel` (integer) The number of levels to expand inner object inline. The lower this number the faster the response. Example: "1" ## Header parameters: - `X-API-Key` (string, required) API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key. - `X-JAY-TRACKING` (string) Tracking session header for user tracking and analytics. This is set by the /playouts/{playout_id}/tracking/session endpoint. Example: "eyJzZXNzaW9uX2lkIjoiZXhhbXBsZS1zZXNzaW9uLWlkLTEyMzQiLCJzdGFydF90aW1lIjoiMjAyNS0wMS0wMVQxMjowMDowMC4wMDAwMDAiLCJzb3VyY2UiOiJqYXkuYXBpLnBsYXlvdXQuZXhhbXBsZSJ9" ## Response 200 fields (application/json): - `data` (object) The response data. 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":"<>","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":"<>","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"]}]} - `data.title` (string) The title of this episode Example: "string" - `data.subtitle` (string) The subtitle of this episode Example: "string" - `data.description` (string) The description of this episode Example: "string" - `data.custom1` (string) The custom field #1 of this episode Example: "string" - `data.custom2` (string) The custom field #2 of this episode Example: "string" - `data.custom3` (string) The custom field #3 of this episode Example: "string" - `data.images` (array) The images related to this episode Example: [{"url":"string","copyright":"string"}] - `data.images.url` (string) The image URL of this image - `data.images.copyright` (string) The image copyright of this image - `data.links` (array) The links related to this episode Example: [{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}] - `data.links.url` (string) The link URL of this object - `data.links.urlLabel` (string) The link label of this object - `data.links.urlNote` (string) The link note of this object - `data.links.urlImage` (object) The link image of this object - `data.language` (string) The language of this episode Example: "string" - `data.country` (string) The country of this episode Example: "string" - `data.characterCount` (integer) The number of characters of this episode - `data.actorCount` (integer) The number of actors of this episode - `data.locationCount` (integer) The number of locations of this episode - `data.costumeCount` (integer) The number of costumes of this episode - `data.propCount` (integer) The number of props of this episode - `data.ticketCount` (integer) The number of tickets of this episode - `data.themeCount` (integer) The number of themes of this episode - `data.basicCount` (integer) The number of basics of this episode - `data.musicCount` (integer) The number of musics of this episode - `data.productCount` (integer) The number of products of this episode - `data.groupCount` (integer) The number of groups of this episode - `data.mainGroupId` (string) The main group of this episode Example: "string" - `data.mainGroup` (object) The main group of this episode Example: {"id":"string","kind":"<>","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"]} - `data.mainGroup.id` (string) The identifier of this object Example: "string" - `data.mainGroup.kind` (string) The kind of information of this object Enum: "character", "actor", "location", "product", "costume", "props", "music", "group", "chapter", "ticket", "theme", "basic", "scene" - `data.mainGroup.mainMenu` (boolean) The main menu marker of this group Example: true - `data.mainGroup.name` (string) The name of this group Example: "string" - `data.mainGroup.subtitle` (string) The subtitle of this group Example: "string" - `data.mainGroup.description` (string) The description of this group Example: "string" - `data.mainGroup.images` (array) The images related to this group Example: [{"url":"string","copyright":"string"}] - `data.mainGroup.links` (array) The links related to this group Example: [{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}] - `data.mainGroup.layout` (string) The layout of this group Example: "string" - `data.mainGroup.groupIds` (array) The identifiers of the groups related to this group Example: ["item"] - `data.mainGroup.groups` (array) The groups of this group Example: ["item"] - `data.mainGroup.characterIds` (array) The identifiers of the characters related to this group Example: ["item"] - `data.mainGroup.actorIds` (array) The identifiers of the actors related to this group Example: ["item"] - `data.mainGroup.locationIds` (array) The identifiers of the locations related to this group Example: ["item"] - `data.mainGroup.costumeIds` (array) The identifiers of the costumes related to this group Example: ["item"] - `data.mainGroup.productIds` (array) The identifiers of the products related to this group Example: ["item"] - `data.mainGroup.propIds` (array) The identifiers of the props related to this group Example: ["item"] - `data.mainGroup.ticketIds` (array) The identifiers of the tickets related to this group Example: ["item"] - `data.mainGroup.themeIds` (array) The identifiers of the themes related to this group Example: ["item"] - `data.mainGroup.basicIds` (array) The identifiers of the basics related to this group Example: ["item"] - `data.mainGroup.musicIds` (array) The identifiers of the musics related to this group Example: ["item"] - `data.groupIds` (array) The groups of this episode Example: ["item"] - `data.groups` (array) The groups of this episode Example: [{"id":"string","kind":"<>","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"]}] - `nextToken` (string) The token, which can be used to retrieve the next page of data. - `error` (object) Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error. - `error.code` (integer, required) The API error code Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503 - `error.message` (string, required) The API error message. - `error.details` (any) The HTTP error details. ## Response 404 fields (application/json): - `data` (object) The response data. 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":"<>","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":"<>","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"]}]} - `data.title` (string) The title of this episode Example: "string" - `data.subtitle` (string) The subtitle of this episode Example: "string" - `data.description` (string) The description of this episode Example: "string" - `data.custom1` (string) The custom field #1 of this episode Example: "string" - `data.custom2` (string) The custom field #2 of this episode Example: "string" - `data.custom3` (string) The custom field #3 of this episode Example: "string" - `data.images` (array) The images related to this episode Example: [{"url":"string","copyright":"string"}] - `data.images.url` (string) The image URL of this image - `data.images.copyright` (string) The image copyright of this image - `data.links` (array) The links related to this episode Example: [{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}] - `data.links.url` (string) The link URL of this object - `data.links.urlLabel` (string) The link label of this object - `data.links.urlNote` (string) The link note of this object - `data.links.urlImage` (object) The link image of this object - `data.language` (string) The language of this episode Example: "string" - `data.country` (string) The country of this episode Example: "string" - `data.characterCount` (integer) The number of characters of this episode - `data.actorCount` (integer) The number of actors of this episode - `data.locationCount` (integer) The number of locations of this episode - `data.costumeCount` (integer) The number of costumes of this episode - `data.propCount` (integer) The number of props of this episode - `data.ticketCount` (integer) The number of tickets of this episode - `data.themeCount` (integer) The number of themes of this episode - `data.basicCount` (integer) The number of basics of this episode - `data.musicCount` (integer) The number of musics of this episode - `data.productCount` (integer) The number of products of this episode - `data.groupCount` (integer) The number of groups of this episode - `data.mainGroupId` (string) The main group of this episode Example: "string" - `data.mainGroup` (object) The main group of this episode Example: {"id":"string","kind":"<>","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"]} - `data.mainGroup.id` (string) The identifier of this object Example: "string" - `data.mainGroup.kind` (string) The kind of information of this object Enum: "character", "actor", "location", "product", "costume", "props", "music", "group", "chapter", "ticket", "theme", "basic", "scene" - `data.mainGroup.mainMenu` (boolean) The main menu marker of this group Example: true - `data.mainGroup.name` (string) The name of this group Example: "string" - `data.mainGroup.subtitle` (string) The subtitle of this group Example: "string" - `data.mainGroup.description` (string) The description of this group Example: "string" - `data.mainGroup.images` (array) The images related to this group Example: [{"url":"string","copyright":"string"}] - `data.mainGroup.links` (array) The links related to this group Example: [{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}] - `data.mainGroup.layout` (string) The layout of this group Example: "string" - `data.mainGroup.groupIds` (array) The identifiers of the groups related to this group Example: ["item"] - `data.mainGroup.groups` (array) The groups of this group Example: ["item"] - `data.mainGroup.characterIds` (array) The identifiers of the characters related to this group Example: ["item"] - `data.mainGroup.actorIds` (array) The identifiers of the actors related to this group Example: ["item"] - `data.mainGroup.locationIds` (array) The identifiers of the locations related to this group Example: ["item"] - `data.mainGroup.costumeIds` (array) The identifiers of the costumes related to this group Example: ["item"] - `data.mainGroup.productIds` (array) The identifiers of the products related to this group Example: ["item"] - `data.mainGroup.propIds` (array) The identifiers of the props related to this group Example: ["item"] - `data.mainGroup.ticketIds` (array) The identifiers of the tickets related to this group Example: ["item"] - `data.mainGroup.themeIds` (array) The identifiers of the themes related to this group Example: ["item"] - `data.mainGroup.basicIds` (array) The identifiers of the basics related to this group Example: ["item"] - `data.mainGroup.musicIds` (array) The identifiers of the musics related to this group Example: ["item"] - `data.groupIds` (array) The groups of this episode Example: ["item"] - `data.groups` (array) The groups of this episode Example: [{"id":"string","kind":"<>","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"]}] - `nextToken` (string) The token, which can be used to retrieve the next page of data. - `error` (object) Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error. - `error.code` (integer, required) The API error code Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503 - `error.message` (string, required) The API error message. - `error.details` (any) The HTTP error details. ## Response 422 fields (application/json): - `data` (object) The response data. 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":"<>","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":"<>","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"]}]} - `data.title` (string) The title of this episode Example: "string" - `data.subtitle` (string) The subtitle of this episode Example: "string" - `data.description` (string) The description of this episode Example: "string" - `data.custom1` (string) The custom field #1 of this episode Example: "string" - `data.custom2` (string) The custom field #2 of this episode Example: "string" - `data.custom3` (string) The custom field #3 of this episode Example: "string" - `data.images` (array) The images related to this episode Example: [{"url":"string","copyright":"string"}] - `data.images.url` (string) The image URL of this image - `data.images.copyright` (string) The image copyright of this image - `data.links` (array) The links related to this episode Example: [{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}] - `data.links.url` (string) The link URL of this object - `data.links.urlLabel` (string) The link label of this object - `data.links.urlNote` (string) The link note of this object - `data.links.urlImage` (object) The link image of this object - `data.language` (string) The language of this episode Example: "string" - `data.country` (string) The country of this episode Example: "string" - `data.characterCount` (integer) The number of characters of this episode - `data.actorCount` (integer) The number of actors of this episode - `data.locationCount` (integer) The number of locations of this episode - `data.costumeCount` (integer) The number of costumes of this episode - `data.propCount` (integer) The number of props of this episode - `data.ticketCount` (integer) The number of tickets of this episode - `data.themeCount` (integer) The number of themes of this episode - `data.basicCount` (integer) The number of basics of this episode - `data.musicCount` (integer) The number of musics of this episode - `data.productCount` (integer) The number of products of this episode - `data.groupCount` (integer) The number of groups of this episode - `data.mainGroupId` (string) The main group of this episode Example: "string" - `data.mainGroup` (object) The main group of this episode Example: {"id":"string","kind":"<>","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"]} - `data.mainGroup.id` (string) The identifier of this object Example: "string" - `data.mainGroup.kind` (string) The kind of information of this object Enum: "character", "actor", "location", "product", "costume", "props", "music", "group", "chapter", "ticket", "theme", "basic", "scene" - `data.mainGroup.mainMenu` (boolean) The main menu marker of this group Example: true - `data.mainGroup.name` (string) The name of this group Example: "string" - `data.mainGroup.subtitle` (string) The subtitle of this group Example: "string" - `data.mainGroup.description` (string) The description of this group Example: "string" - `data.mainGroup.images` (array) The images related to this group Example: [{"url":"string","copyright":"string"}] - `data.mainGroup.links` (array) The links related to this group Example: [{"url":"string","urlLabel":"string","urlNote":"string","urlImage":{"url":"string","copyright":"string"}}] - `data.mainGroup.layout` (string) The layout of this group Example: "string" - `data.mainGroup.groupIds` (array) The identifiers of the groups related to this group Example: ["item"] - `data.mainGroup.groups` (array) The groups of this group Example: ["item"] - `data.mainGroup.characterIds` (array) The identifiers of the characters related to this group Example: ["item"] - `data.mainGroup.actorIds` (array) The identifiers of the actors related to this group Example: ["item"] - `data.mainGroup.locationIds` (array) The identifiers of the locations related to this group Example: ["item"] - `data.mainGroup.costumeIds` (array) The identifiers of the costumes related to this group Example: ["item"] - `data.mainGroup.productIds` (array) The identifiers of the products related to this group Example: ["item"] - `data.mainGroup.propIds` (array) The identifiers of the props related to this group Example: ["item"] - `data.mainGroup.ticketIds` (array) The identifiers of the tickets related to this group Example: ["item"] - `data.mainGroup.themeIds` (array) The identifiers of the themes related to this group Example: ["item"] - `data.mainGroup.basicIds` (array) The identifiers of the basics related to this group Example: ["item"] - `data.mainGroup.musicIds` (array) The identifiers of the musics related to this group Example: ["item"] - `data.groupIds` (array) The groups of this episode Example: ["item"] - `data.groups` (array) The groups of this episode Example: [{"id":"string","kind":"<>","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"]}] - `nextToken` (string) The token, which can be used to retrieve the next page of data. - `error` (object) Details of the error that occurred during the API request, including error code and message. This field is only present when the request results in an error. - `error.code` (integer, required) The API error code Enum: 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 3000, 3001, 3002, 3003, 3004, 3005, 3006, 3007, 4001, 4002, 5001, 5002, 5003, 5004, 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 422, 423, 501, 503 - `error.message` (string, required) The API error message. - `error.details` (any) The HTTP error details.