Developer Console
Thank you for your visit. This page is only available in English at this time.

Entity Types for Video Content (VSK Echo Show)

The entities object consists of a list of objects, each of which contains a type and a value along with other possible data such as external ids. Possible values are listed in the sections that follow.

Actor

Actor represents an actor credited in video media content; for example, Gaby Hoffman might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
ASIN The external ASIN of this entity String B01M3X9T06
Gracenote The Gracenote identifier for the actor. String ST0000000666661
uri URI mapping to the actor/actress URI entity://provider/actor/caseyaffleck
value The name of the actor String Gaby Hoffman

App

App represents the explicit app name specified by the user in utterance; for example, "Manchester by the Sea on Prime" might contain the following.

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
ENTITY_ID An application identifier from a list of apps. String amzn1.alexa-ask-target.app.72095
value The name of the application String Prime Video

Channel

Channel represents the identifying data for a television channel; for example, "PBS" might contain the following

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The external Gracenote identifier String ST0000000666661
entityMetadata A map of meta data associated with the channel Object
channelNumber The channel number Integer 1234
channelCallSign The call sign for the channel String KBTC
uri The URI of the channel URI entity://provider/channel/1234
value The name of the channel String PBS

Character

A character represented in video media content; for example, Snow White might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
ASIN The Amazon Standard Identification Number (ASIN) for this entity String B00DT55P3K
Gracenote The Gracenote identifier for the character. String ST0000000123456
uri URI mapping to the character URI entity://provider/character/harrypotter
value The name of the character String Snow White

Director

Director represents the director name for the video media content; for example, "Kenneth Lonergan" might contain the following.

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The external Gracenote identifier String MV0000000666661
uri URI mapping to the director URI entity://provider/director/kennethlonergan
value The name of the director String Kenneth Lonergan

Episode

Episode represents the episode number for serial content like TV Shows; for example, the eighth episode of "Transparent" would have episode number 8.

Field Description Type Example
value The episode number Integer 8

Event

An event is a reference to a type of event; examples would include sports, music, or other types of events. For example, searching for "Football games" would search for a game event entity and a football sport entity.

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The Gracenote identifier for the event. String ST0000000666661
uri URI mapping to the event URI entity://amazon/events/games
value The name of the event type String Games

Franchise

A franchise is a video entity which can represent a number of video entities, like movies or TV shows. For example, take the fictional franchise "Intergalactic Wars" which represents a collection of movie trilogies, as well as animated and live action TV shows. This entity type was introduced to account for requests by customers such as "Find Intergalactic Wars movies", which would search for all "Intergalactic Wars" programs of the MOVIE value for MediaType, rather than attempting to match to a single title.

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The external Gracenote identifier String ST0000000666661
uri URI mapping to the franchise URI mapping to the event entity://amazon/franchise/intergalacticwars
value The name of the genre String Intergalactic Wars

Genre

Genre represents the genre of video media content such as action, drama or comedy. For example, the Action genre might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The external Gracenote identifier String ST0000000666661
uri URI mapping to the genre URI entity://provider/genre/action
value The name of the genre String Action

League

League represents the categorical information for a sporting league; for example, NCAA is a league that might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The Gracenote identifier for the league String ST0000000666661
uri URI mapping to the league URI entity://amazon/league/ncaa
value The name of the league String NCAA

MediaType

MediaType represents the media type category of a particular piece of content; for example, the MediaType for "Manchester by the Sea" would be MOVIE.

Field Description Type Example
value The media type; possible values are MOVIE, VIDEO, TV_SHOW Enum MOVIE

ProductionCompany

ProductionCompany represents the production company name for the video media content; for example, Marvels, Disney.

Field Description Type Example
value Production company name String Marvel

Season

Season represents the season number for serial content like TV Shows; for example, the season two of "Transparent" would have season number 2.

Field Description Type Example
value The season number Integer 2

Sport

Sport represents the categorical information of a sport; for example, football is a sport that might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The Gracenote identifier for the sport String ST0000000666661
uri URI mapping to the sports URI entity://amazon/sport/football
value The name of the sport String Football

SportsTeam

SportsTeam represents the categorical information of a professional sports team; for example, "University of Washington Huskies" is a sports team that might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
Gracenote The Gracenote identifier for this team. String ST0000000666661
uri URI mapping to the sports team URI entity://amazon/sportsteam/huskies
value The name of the sports team String University of Washington Huskies

Video

Video represents the identifying data for the piece of video content; for example, "Manchester by the Sea" might contain the following:

Field Description Type Example
externalIds A map of external identifiers for this entity. Key is the provider, value is the id. Object
ASIN The external ASIN of this entity String B01M3X9T06
Gracenote The Gracenote identifier String MV0000000666661
userConfirmations Object containing information about user confirmations for the item Object
entitlementVoiceActivation Flag to inform partner if voice enablement of viewing period or entitlement is successful. Possible values - CONFIRMED (optional). Enum; Default policy - unrecognized values are ignored CONFIRMED
uri URI mapping to the video URI entity://provider/movie/manchesterbythesea
value The name of the video String Manchester by the Sea

Popularity

Popularity indicates whether the user asks for popular content.

Field Description Type Example
value Indicates to provider that the user searches for popular content String TRUE

Note that this entity type does not have any externalIds included. A sample response (excerpted to the relevant values only) might look as follows:

"entities": [..{
                "value": "TRUE",
                "type": "Popularity"
              }
            ..],

Recency

The resolved values for Recency indicate whether the user asks for new or old content.

Field Description Type Example
value Indicates whether the user searches for new or old content; possible values are NEW, OLD Enum NEW

Note that this entity type does not have any externalIds included. A sample response (excerpted to the relevant values only) might look as follows:

"entities": [..{
                "value": "NEW",
                "type": "Recency"
              }
            ..],

VideoResolution

VideoResolution represents the requested video resolution in one of the following standards:

  • SD (480p)
  • HD (720p-1080p)
  • 4k (2160p)
  • 8k (4320p)
Field Description Type Example
value Video resolution; possible values are SD, HD, 4k, 8k Enum HD

Note that this entity type does not have any externalIds included. A sample response (excerpted to the relevant values only) might look as follows:

"entities": [..{
                "value": "4k",
                "type": "VideoResolution"
              }
            ..],

Example: GetPlayableItems with Entities Specified

The following is a payload for a GetPlayableItems directive showing "type": "Video" in the entities array in the payload.

{
    "directive": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
            "messageId": "9f4803ec-4c94-4fdf-89c2-d502d5e52bb4",
            "name": "GetPlayableItems",
            "namespace": "Alexa.VideoContentProvider",
            "payloadVersion": "3"
        },
        "endpoint": {
            "scope": {
                "type": "BearerToken",
                "token": "access-token-from-skill"
            },
            "endpointId": "videoDevice-001",
            "cookie": {

            }
        },
        "payload": {
            "entities": [
                {
                    "type": "Video",
                    "value": "Manchester by the Sea",
                    "externalIds": {
                        "gracenote": "MV000000099001"
                    }
                }
            ],
            "contentType": "RECORDING",
            "locale": "en-US",
            "minResultLimit": 8,
            "maxResultLimit": 25,
            "timeWindow": {
                "end": "2016-09-07T23:59:00+00:00",
                "start": "2016-09-01T00:00:00+00:00"
            }
        }
    }
}