Skill Manifest Schema

The skill manifest is the JSON representation of your skill, and provides Alexa with all of the metadata required. The interaction model and account linking schemas, if used, are separate.

All images referenced in a skill manifest must be in PNG format.

See also: Alexa Skills Kit Command Line Interface and Alexa Skill Management API Overview and Skill Operations

View the sample manifests to see how the final JSON format appears.

Manifest

Field Description Type
manifestVersion Version of the skill manifest. String
publishingInformation Object that contains the information to determine how the skill is presented to end users in the skill store or Alexa app. Object
privacyAndCompliance Object that contains the options related to user privacy, such as the URLs for your privacy policy and terms of use. Object
permissions Array that specifies the permissions that let you ask the user for specific personal information, such as access to the address of their device. Array of Object
events Object that specifies the events a skill wants to subscribe to. E.g. notify the skill whenever a customer enables or disables the skill. Object
apis Object that specifies required information for all interfaces that a skill supports. Object

publishingInformation

Field Description Type
locales Object that contains <locale> objects for each supported locale. Object
distributionCountries Array specifying distribution country/region strings in ISO 3166-1 alpha-2 format, for example US, GB or DE. This array should only contain values if availableWorldwide is false. Array of String
isAvailableWorldwide Set to true to indicate the skill is available worldwide, and otherwise false. If false, countries must be listed for distributionCountries. boolean
distributionMode PUBLIC if the skill is distributed without restriction. PRIVATE if the skill is available only to a private distribution list. enum
testingInstructions Indicates any special instructions to test the skill, such as a test account. String
category Indicates the filter category for the skill in the Alexa App such as NEWS or SMART_HOME. See Category enumeration. enum

locales

For each supported locale, include an object with the appropriate locale String. Supported values include: de-DE, en-AU, en-CA, en-GB, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, and pt-BR.

Field Description Type
summary Summary description of the skill, which is shown when viewing the list of skills in the Alexa Skills Store. String
description A full description explaining what the skill can do and any prerequisites to using it (such as additional hardware, software, or accounts). For a Flash Briefing skill, you must list the feeds for the skill. String
smallIconUri A small icon (108 by 108 pixels) for the skill, which is shown when viewing the list of skills in the Alexa Skills Store. The value can be a publicly-accessible URL or, when using the skill package format, a path relative to the skill package's skill.json file, such as file://assets/images/en-US_smallIcon.png. String
largeIconUri A large icon (512 by 512 pixels) for the skill, which is shown when viewing the list of skills in the Alexa Skills Store. The value can be a publicly-accessible URL or, when using the skill package format, a path relative to the skill package's skill.json file, such as file://assets/images/en-US_largeIcon.png. String
examplePhrases Three example phrases that illustrate how users can invoke your skill. For accuracy, these phrases must come directly from your sample utterances. Array of Strings
keywords Sample keyword phrases that describe the skill. Array of Strings
updatesDescription Description of the skill's new features and fixes in this version. Should describe changes in the revisions of the skill. String

privacyAndCompliance

When you create or modify a skill using a skill manifest, you must ensure that the customer meets the privacy and compliance requirements and the export compliance requirement. The requirements for the customer are the same as the customer must comply with if creating a skill on the Amazon Developer Portal, as shown on the Privacy and Compliance tab when creating a skill on the portal.

The customer must answer all of the corresponding questions to set the values for the privacyAndCompliance Object. If the customer answers Yes, set the value to true, and if the customer answers No, set the value to false. You may not provide default answers or values on behalf of the customer.

Field Description Type
allowsPurchases true to indicate purchases can be made from this skill; otherwise, false. boolean
usesPersonalInfo true to indicate this skill uses customer information, otherwise false. boolean
isChildDirected true to indicate the skill is directed at children under 13, otherwise false. To create a child-directed skill, isChildDirected must be set to true, and the publishingInformation.category must be set to one of the following: CHILDRENS_EDUCATION_AND_REFERENCE, CHILDRENS_GAMES, CHILDRENS_MUSIC_AND_AUDIO, CHILDRENS_NOVELTY_AND_HUMOR. boolean
isExportCompliant true to indicate the skill can be exported to any country/region; otherwise, false. boolean
containsAds true to indicate the skill contains advertising; otherwise, false. boolean
locales Object that contains <locale> objects for each supported locale. Object

When you create or modify a skill using a skill manifest, you must ensure that the customer meets the privacy and compliance requirements and the export compliance requirement. The requirements for the customer are the same as the customer must comply with if creating a skill on the Amazon Developer Portal, as shown on the Privacy and Compliance tab when creating a skill on the portal.

The customer must answer the corresponding questions in order to set the values for the privacyAndCompliance object. If the customer answers Yes, set the value to true, and if the customer answers No, set the value to false. You may not provide default answers or values on behalf of the customer.

FieldCorresponding question from Amazon Developer Portal
allowsPurchases Does this skill allow users to make purchases or spend real money?
usesPersonalInfoDoes this Alexa skill collect users' personal information? This includes anything that can identify the user such as name, email, password, phone number, birthdate, etc.
isChildDirected

Is this skill directed to or does it target children under the age of 13?

Please indicate if this skill is directed to children under the age of 13 (for the United States, as determined under the Children's Online Privacy Protection Act (COPPA)).

Not Sure?
isExportCompliantCheckbox: I certify that this Alexa skill may be imported to and exported from the United States and all other countries and regions in which we operate our program or in which you've authorized sales to end users (without the need for us to obtain any license or clearance or take any other action) and is in full compliance with all applicable laws and regulations governing imports and exports, including those applicable to software that makes use of encryption technology.
containsAdsDoes this skill contain advertising?
privacyPolicyUrlPrivacy Policy URL (Optional) Link to the privacy policy that applies to this skill.
Note: Each locale requires a separate privacy policy URL, if one is provided.
termsOfUse Terms of Use URL (Optional) Link to the terms of use document for this skill.
Note: Each locale requires a separate terms of use URL, if one is provided.

locales

For each supported locale, include an object with the appropriate locale string. Supported values include: de-DE, en-AU, en-CA, en-GB, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, and pt-BR.

Field Description Type
privacyPolicyUrl URL to the privacy policy for the skill for the locale String
termsOfUseUrl URL to the terms of use for the skill. for the locale String

permissions

An array of named permissions that the skill can use. A flash briefing skill cannot include a permissions object.

Field Description Type
name

Contains an array of permissions, which can contain some or all of the following, which are read from the Alexa app settings.

alexa::alerts:reminders:skill:readwrite – Read/write permission for reminder alerts.

alexa:devices:all:address:country_and_postal_code:read – Read the customer's country or region and postal code.

alexa::devices:all:geolocation:read – Read permission for location services.

alexa::devices:all:address:full:read – Read the customer's full address.

alexa::devices:all:notifications:write – Write to the customer's Alexa notifications.

alexa::household:lists:read – Read the customer's Alexa lists.

alexa::household:lists:write – Write to the customer's Alexa lists.

alexa::person_id:read – Read the personId value.

alexa::profile:email:read – Read the customer's email address.

alexa::profile:given_name:read – Read the customer's given name or first name.

alexa::profile:mobile_number:read – Read the customer's phone number.

alexa::profile:name:read – Read the customer's full name.

 array

events

Field Description Type
publications Contains an array of eventName objects, each of which contains the name of a proactive event. See Schemas for Proactive Events. Array of Object
subscriptions Contains an array of eventName objects, each of which contains the name of a skill event. These include: SKILL_PROACTIVE_SUBSCRIPTION_CHANGED,SKILL_PERMISSION_CHANGED, and SKILL_PERMISSION_ACCEPTED. Array of Object
endpoint Contains the uri field. This sets the global default endpoint for events. Object
regions Contains an array of the supported <region> Objects. Array of Object
sslCertificateType SSL certificate type for the skill's HTTPS endpoint. Only valid for HTTPS endpoints, not for AWS Lambda ARN. See sslCertificateType enumeration. enum

See Skill Events and List Events.

endpoint

Sets the global default endpoint for events.

Field Description Type
uri The Amazon Resource Name (ARN) of the Lambda function, or the HTTPS URL for a custom endpoint. String

regions

An array of <region> objects.

Field Description Type
<region> Two-letter code for the geographic region such as NA/EU/FE enum
Field Description Type
endpoint Contains the uri field. A regional endpoint overrides the global default endpoint for the specified region. Object

endpoint

Sets the region-specific override endpoint, as compared to events.endpoint, which sets the global default endpoint. If set to Default, the global default endpoint is used for the region.

Field Description Type
uri The Amazon Resource Name (ARN) of the Lambda function, or the HTTPS URL for a custom endpoint. String

apis

An array of objects. Some combinations of objects are not supported.

Field Description Type
<api-type> See api enumeration enum

alexaForBusiness

All skills that have alexaForBusiness as a property of the apis object must be English (U.S.) only. Thus, although the manifest supports multiple regions and regional overrides, these are not applicable in this case.

Field Description Type
endpoint Contains the uri field. Sets the global default endpoint, which can be overridden on a region-by-region basis. Object
regions Contains an array of the supported <region> Objects. Array of Object
interfaces Contains an array of the supported interfaces Array of Object

endpoint

Sets the global default endpoint for apis.alexaForBusiness.endpoint.

Field Description Type
uri Amazon Resource Name (ARN) for the skill's Lambda function or HTTPS URL String

regions

An array of <region> fields.

Field Description Type
<region> Two-letter code for the geographic region such as NA/EU/FE. enum
Field Description Type
endpoint Contains the uri field. Object
endpoint

Sets the region-specific override endpoint, as compared to apis.alexaForBusiness.endpoint, which sets the global default endpoint.

Field Description Type
uri Amazon Resource Name (ARN) for the skill's Lambda function or HTTPS URL String

interfaces

Contains an array of interface objects.

Each interface object contains the following fields.

Field Description Type
namespace Must be Alexa.Business.Reservation.Room enum
version Version of the object. Currently 1.0. enum
requests Array of requests. enum
requests

Contains an array of name objects.

Field Description Type
name One of Search, Create, Update enum

custom

Field Description Type
endpoint Contains the uri and sslCertificateType fields. Sets the global default endpoint, which can be overridden on a region-by-region basis. Object
regions Contains an array of the supported <region> Objects. Array of Object
interfaces Contains an array of the supported interfaces Array of Object
tasks Contains an array of the supported skill connection tasks. See the list of tasks at Supported skill connection tasks Array of Object

endpoint

Sets the global default endpoint for apis.custom.endpoint.

Field Description Type
uri Amazon Resource Name (ARN) for the skill's custom Lambda function or HTTPS URL String
sslCertificateType The SSL certificate type for the skill's HTTPS endpoint. Only valid for HTTPS endpoints, not for AWS Lambda ARN. See sslCertificateType enumeration. enum

regions

An array of <region> fields.

Field Description Type
<region> Two-letter code for the geographic region such as NA/EU/FE. enum
Field Description Type
endpoint Contains the uri and sslCertificate fields. Object
endpoint

Sets the region-specific override endpoint, as compared to apis.custom.endpoint, which sets the global default endpoint.

Field Description Type
uri Amazon Resource Name (ARN) for the skill's custom Lambda function or HTTPS URL String
sslCertificateType The SSL certificate type for the skill's HTTPS endpoint. Only valid for HTTPS endpoints, not for AWS Lambda ARN. See sslCertificateType enumeration enum

interfaces

An array of interfaces supported by the skill.

Field Description Type
type See customInterface enumeration. enum

smartHome

Field Description Type
endpoint Contains the uri field. Object
regions Contains an array of the supported <region> Objects Array of Object
protocolVersion (Optional) Version of the Smart Home API. Default and recommended value is '3'. You may create a skill with version '2' for testing migration to version '3', but a skill submission using version '2' will not be certified. String

endpoint

Sets the global default endpoint.

Field Description Type
uri Amazon Resource Name (ARN) for the skill's smartHome Lambda function. String

regions

An array of <region> fields.

Field Description Type
<region> Two-letter code for the geographic region such as NA/EU/FE enum
Field Description Type
endpoint Contains the uri field. Object
endpoint

Sets the region-specific override endpoint, as compared to apis.smartHome.endpoint, which sets the global default endpoint.

Field Description Type
uri Amazon Resource Name (ARN) for the skill's smartHome Lambda function String

flashBriefing

Field Description Type
locales Object that contains <locale> Objects for each supported locale. Object

locales

For each supported locale, include an object with the appropriate locale String. Supported values include: de-DE, en-AU, en-CA, en-GB, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, and pt-BR.

Field Description Type
<locale> Locale String Object
Field Description Type
customErrorMessage Customized error message if the flash briefing is unavailable String
feeds Object containing an array of feeds Object
feeds
Field Description Type
name Name of the feed String
isDefault If true, the feed is included in the flash briefing by default. If false, it is not. boolean
vuiPreamble Preamble to flash briefing String
updateFrequency See UpdateFrequency enumeration enum
genre See ContentGenre enumeration enum
imageUri URI of the image used for the skill in the skill store. String
contentType See ContentType enumeration enum
url URL of the content of the feed. String

householdList

Empty Object.

music

See Example music and radio skill manifest.

video

Field Description Type
countries Object that contains <country> Objects for each supported country. Object
locales Object that contains <locale> Objects for each supported locale. Object
regions Contains an array of the supported <region> Objects. Array of Object
protocolVersion (Optional) Version of the Video API. The default and recommended value is 3.0. String

countries

For each supported country, include an Object with the appropriate country string. Supported values include: AU, BR, CA, DE, ES, FR, GB, IN, IT, JP, MX, and US.

Field Description Type
<country> Country String Object
Field Description Type
catalogInformation Contains an array of the supported Catalog Types and their values. Array of Object

catalogInformation

Field Description Type
type Type of Catalog such as "INGESTED_CONTENT_IDENTIFIER" for integrated catalogs or "LIVE_TV_MSO" for MSO ID. enum
sourceId Value of the catalog identifier. String

locales

For each supported locale, include an Object with the appropriate locale string. Supported values include: de-DE, en-AU, en-CA, en-GB, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, and pt-BR.

Field Description Type
<locale> Locale String Object
Field Description Type
videoProviderTargetingNames List of names. Array
features List of features, applicable to video skills for multimodal devices. Array of Object

features

This is only applicable to video skills for multimodal devices.

Field Description Type
version Version number such as "1.0". enum
players Contains web player information. Array of Object
name Name of the feature such as "VIDEO_WEB_PLAYER". enum

players

Contains web player information.

Field Description Type
logoImageUri URI for the logo image. String
type Type of the web player such as "AVS_3P_PROVIDED". enum
uri URI for the web player. String
backgroundImageUri URI for the background image. String

regions

An array of <region> fields.

Field Description Type
<region> Two-letter code for the geographic region such as NA/EU/FE enum
Field Description Type
endpoint Contains the uri field. Object
endpoint

Sets the region-specific endpoint.

Field Description Type
uri Amazon Resource Name (ARN) for the skill's video AWS Lambda function String

Enumerations and Values

API enumeration

This enumeration provides values for the api names.

Enum Values
alexaForBusiness
custom
flashBriefing
health
householdList
music
smartHome
video

SSLCertificateType enumeration

This enumeration provides values for the SSL certificate type for the skill's HTTPS endpoint.

Enum Values
SelfSigned
Trusted
Wildcard

CustomInterface enumeration

This enumeration provides values for the interfaces supported by a custom skill.

Enum Values
ALEXA_PRESENTATION_APL
AUDIO_PLAYER
CAN_FULFILL_INTENT_REQUEST
GADGET_CONTROLLER
GAME_ENGINE
RENDER_TEMPLATE
VIDEO_APP

UpdateFrequency enumeration

This enumeration provides values for the frequency of feed content updates.

Enum value Description
DAILY Feed content is updated daily.
HOURLY Feed content is updated hourly.
WEEKLY Feed content is updated weekly.

ContentType enumeration

This enumeration provides values for the different types of feeds for a Flash Briefing skill.

Enum value Description
TEXT Indicates the content of the feed is text to be read by Alexa.
AUDIO Indicates the content of the feed audio content to be played by Alexa.

ContentGenre enumeration

This enumeration describes the type of content provided by the Flash Briefing feed.

Enum Values
HEADLINE_NEWS
BUSINESS
POLITICS
ENTERTAINMENT
TECHNOLOGY
HUMOR
LIFESTYLE
SPORTS
SCIENCE
HEALTH_AND_FITNESS
ARTS_AND_CULTURE
PRODUCTIVITY_AND_UTILITIES
OTHER

Category enumeration

This enumeration provides category values. The category determines how your skill is filtered for display in the Alexa app.

Enum Values
ALARMS_AND_CLOCKS
ASTROLOGY
BUSINESS_AND_FINANCE
CALCULATORS
CALENDARS_AND_REMINDERS
CHILDRENS_EDUCATION_AND_REFERENCE
CHILDRENS_GAMES
CHILDRENS_MUSIC_AND_AUDIO
CHILDRENS_NOVELTY_AND_HUMOR
COMMUNICATION
CONNECTED_CAR
COOKING_AND_RECIPE
CURRENCY_GUIDES_AND_CONVERTERS
DATING
DELIVERY_AND_TAKEOUT
DEVICE_TRACKING
EDUCATION_AND_REFERENCE
EVENT_FINDERS
EXERCISE_AND_WORKOUT
FASHION_AND_STYLE
FLIGHT_FINDERS
FRIENDS_AND_FAMILY
GAME_INFO_AND_ACCESSORY
GAMES
HEALTH_AND_FITNESS
HOTEL_FINDERS
KNOWLEDGE_AND_TRIVIA
MOVIE_AND_TV_KNOWLEDGE_AND_TRIVIA
MOVIE_INFO_AND_REVIEWS
MOVIE_SHOWTIMES
MUSIC_AND_AUDIO_ACCESSORIES
MUSIC_AND_AUDIO_KNOWLEDGE_AND_TRIVIA
MUSIC_INFO_REVIEWS_AND_RECOGNITION_SERVICE
NAVIGATION_AND_TRIP_PLANNER
NEWS
NOVELTY
ORGANIZERS_AND_ASSISTANTS
PETS_AND_ANIMAL
PODCAST
PUBLIC_TRANSPORTATION
RELIGION_AND_SPIRITUALITY
RESTAURANT_BOOKING_INFO_AND_REVIEW
SCHOOLS
SCORE_KEEPING
SELF_IMPROVEMENT
SHOPPING
SMART_HOME
SOCIAL_NETWORKING
SPORTS_GAMES
SPORTS_NEWS
STREAMING_SERVICE
TAXI_AND_RIDESHARING
TO_DO_LISTS_AND_NOTES
TRANSLATORS
TV_GUIDES
UNIT_CONVERTERS
WEATHER
WINE_AND_BEVERAGE
ZIP_CODE_LOOKUP

Sample Manifests

Choose the skill manifest for your skill type. For each skill type, ensure that a skill developer considers the privacy and compliance requirements.

Custom Skill Manifest

{
  "manifest": {
    "publishingInformation": {
      "locales": {
        "en-US": {
          "summary": "This is a sample Alexa custom skill.",
          "examplePhrases": [
            "Alexa, open sample custom skill.",
            "Alexa, play sample custom skill."
          ],
          "keywords": [
            "Descriptive_Phrase_1",
            "Descriptive_Phrase_2",
            "Descriptive_Phrase_3"
          ],
          "smallIconUri": "https://smallUri.com",
          "largeIconUri": "https://largeUri.com",
          "name": "Sample custom skill name.",
          "description": "This skill does interesting things."
        }
      },
      "isAvailableWorldwide": false,
      "testingInstructions": "1) Say 'Alexa, hello world'",
      "category": "HEALTH_AND_FITNESS",
      "distributionCountries": [
        "US",
        "GB",
        "DE"
      ]
    },
    "apis": {
      "custom": {
        "endpoint": {
          "uri": "arn:aws:lambda:us-east-1:040623927470:function:sampleSkill"
        },
        "interfaces": [
          {
            "type":"ALEXA_PRESENTATION_APL"
          },		
          {
            "type":"AUDIO_PLAYER"
          },
          {
            "type":"CAN_FULFILL_INTENT_REQUEST"
          },
          {
            "type":"GADGET_CONTROLLER"
          },
          {
            "type":"GAME_ENGINE"
          },
          {
            "type":"RENDER_TEMPLATE"
          },
          {
            "type":"VIDEO_APP"
          }		  
        ],
        "regions": {
          "NA": {
            "endpoint": {
              "sslCertificateType": "Trusted",
              "uri": "https://customapi.sampleskill.com"
            }
          }
        }
      }
    },
    "manifestVersion": "1.0",
    "permissions": [
      {
        "name": "alexa::devices:all:address:full:read"
      },
      {
        "name": "alexa:devices:all:address:country_and_postal_code:read"
      },
      {
        "name": "alexa::household:lists:read"
      },
      {
        "name": "alexa::household:lists:write"
      },
      {
        "name": "alexa::alerts:reminders:skill:readwrite"
      }
    ],
    "privacyAndCompliance": {
      "allowsPurchases": false,
      "usesPersonalInfo": false,
      "isChildDirected": false,
      "isExportCompliant": true,
      "containsAds": false,
      "locales": {
        "en-US": {
          "privacyPolicyUrl": "http://www.myprivacypolicy.sampleskill.com",
          "termsOfUseUrl": "http://www.termsofuse.sampleskill.com"
        }
      }
    },
    "events": {
      "endpoint": {
        "uri": "arn:aws:lambda:us-east-1:040623927470:function:sampleSkill"
      },
      "subscriptions": [
        {
          "eventName": "SKILL_ENABLED"
        },
        {
          "eventName": "SKILL_DISABLED"
        },
        {
          "eventName": "SKILL_PERMISSION_ACCEPTED"
        },
        {
          "eventName": "SKILL_PERMISSION_CHANGED"
        },
        {
          "eventName": "SKILL_ACCOUNT_LINKED"
        }
      ],
      "regions": {
        "NA": {
          "endpoint": {
            "uri": "arn:aws:lambda:us-east-1:040623927470:function:sampleSkill"
          }
        }
      }
    }
  }
}

List Skill Manifest With No Custom Component

{
  "manifest": {
    "publishingInformation": {
      "locales": {
        "en-US": {
          "summary": "This is a sample Alexa skill.",
          "examplePhrases": [
            "Alexa, open sample skill.",
            "Alexa, play sample skill."
          ],
          "keywords": [
            "Descriptive_Phrase_1",
            "Descriptive_Phrase_2",
            "Descriptive_Phrase_3"
          ],
          "smallIconUri": "https://smallUri.com",
          "largeIconUri": "https://largeUri.com",
          "name": "Sample skill name.",
          "description": "This skill does interesting things."
        }
      },
      "isAvailableWorldwide": false,
      "testingInstructions": "1) Say 'Alexa, hello world'",
      "category": "HEALTH_AND_FITNESS",
      "distributionCountries": [
        "US",
        "GB",
        "DE"
      ]
    },
    "apis": {
      "householdList": {}
    },
    "manifestVersion": "1.0",
    "permissions": [
      {
        "name": "alexa::devices:all:address:full:read"
      },
      {
        "name": "alexa:devices:all:address:country_and_postal_code:read"
      },
      {
        "name": "alexa::household:lists:read"
      },
      {
        "name": "alexa::household:lists:write"
      }
    ],
    "privacyAndCompliance": {
      "allowsPurchases": false,
      "locales": {
        "en-US": {
          "termsOfUseUrl": "http://www.termsofuse.sampleskill.com",
          "privacyPolicyUrl": "http://www.myprivacypolicy.sampleskill.com"
        }
      },
      "isExportCompliant": true,
      "containsAds": false,
      "isChildDirected": false,
      "usesPersonalInfo": false
    },
    "events": {
      "endpoint": {
        "uri": "arn:aws:lambda:us-east-1:040623927470:function:sampleSkill"
      },
      "subscriptions": [
        {
          "eventName": "SKILL_ENABLED"
        },
        {
          "eventName": "SKILL_DISABLED"
        },
        {
          "eventName": "SKILL_PERMISSION_ACCEPTED"
        },
        {
          "eventName": "SKILL_PERMISSION_CHANGED"
        },
        {
          "eventName": "SKILL_ACCOUNT_LINKED"
        },
        {
          "eventName": "ITEMS_CREATED"
        },
        {
          "eventName": "ITEMS_UPDATED"
        },
        {
          "eventName": "ITEMS_DELETED"
        }
      ],
      "regions": {
        "NA": {
          "endpoint": {
            "uri": "arn:aws:lambda:us-east-1:040623927470:function:sampleSkill"
          }
        }
      }
    }
  }
}

Meetings Skill Manifest

{
  "manifest": {
    "apis": {
      "alexaForBusiness": {
        "regions": {
          "NA": {
            "endpoint": {
              "uri": "arn:aws:lambda:us-east-1:123456789:function:myFunctionName1"
            }
          }
        },
        "endpoint": {
          "uri": "arn:aws:lambda:us-east-1:123456789:function:myFunctionName1"
        },
        "interfaces": [
          {
            "namespace": "Alexa.Business.Reservation.Room",
            "version": "1.0",
            "requests": [
              {
                "name": "Search"
              },
              {
                "name": "Create"
              },
              {
                "name": "Update"
              }
            ]
          }
        ]
      }
    },
    "manifestVersion": "1.0",
    "privacyAndCompliance": {
      "locales": {
        "en-US": {
          "privacyPolicyUrl": "http://www.myprivacypolicy.sampleskill.com",
          "termsOfUseUrl": "http://www.termsofuse.sampleskill.com"
        }
      },
      "allowsPurchases": false,
      "usesPersonalInfo": false,
      "isChildDirected": false,
      "isExportCompliant": true,
      "containsAds": false
    },
    "publishingInformation": {
      "locales": {
        "en-US": {
          "name": "Room Booking Skill",
          "smallIconUri": "https://smallUri.example.com/small1.png",
          "largeIconUri": "https://largeUri.example.com/large1.png",
          "summary": "This is a sample Alexa skill.",
          "description": "This skill has Alexa for Business reservations features.",
          "examplePhrases": [
            "Alexa, book this room.",
            "Alexa, find a room at 3pm tomorrow."
          ],
          "keywords": [
            "Meetings",
            "Booking",
            "Alexa For Business"
          ],
          "updatesDescription": "This skill has updates that fix feature bugs."
        }
      },
      "isAvailableWorldwide": false,
      "testingInstructions": "1) Say 'Alexa, Book this room'",
      "category": "CALENDARS_AND_REMINDERS",
      "distributionCountries": [
        "US"
      ]
    }
  }
}

Smart Home Skill Manifest

{
  "manifest": {
    "manifestVersion": "1.0",
    "publishingInformation": {
      "locales": {
        "en-US": {
          "name": "Sample skill name.",
          "summary": "This is a sample Alexa skill.",
          "description": "This skill has basic and advanced smart devices control features.",
          "smallIconUri": "https://smallUri.com",
          "largeIconUri": "https://largeUri.com",
          "examplePhrases": [
            "Alexa, open sample skill.",
            "Alexa, blink kitchen lights."
          ],
          "keywords": [
            "Smart Home",
            "Lights",
            "Smart Devices"
          ]
        }
      },
      "distributionCountries": [
        "US",
        "GB",
        "DE"
      ],
      "isAvailableWorldwide": false,
      "testingInstructions": "1) Say 'Alexa, turn on sample lights'",
      "category": "SMART_HOME"
    },
    "privacyAndCompliance": {
      "allowsPurchases": false,
      "usesPersonalInfo": false,
      "isChildDirected": false,
      "isExportCompliant": true,
      "containsAds": false,
      "locales": {
        "en-US": {
          "privacyPolicyUrl": "http://www.myprivacypolicy.sampleskill.com",
          "termsOfUseUrl": "http://www.termsofuse.sampleskill.com"
        }
      }
    },
    "apis": {
      "smartHome": {
        "endpoint": {
          "uri": "arn:aws:lambda:us-east-1:040623927470:function:sampleSkill"
        },
        "regions": {
          "NA": {
            "endpoint": {
              "uri": "arn:aws:lambda:us-west-2:010623927470:function:sampleSkillWest"
            }
          }
        }
      }
    }
  }
}

Video Skill Manifest

{
  "manifest": {
    "publishingInformation": {
      "locales": {
        "en-US": {
          "summary": "This is a sample Alexa skill.",
          "examplePhrases": [
            "Alexa, tune to channel 206",
            "Alexa, search for comedy movies",
            "Alexa, pause."
          ],
          "keywords": [
            "Video",
            "TV"
          ],
          "name": "VideoSampleSkill",
          "smallIconUri": "https://smallUri.example.com",
          "largeIconUri": "https://smallUri.example.com",
          "description": "This skill has video control features."
        }
      },
      "isAvailableWorldwide": false,
      "testingInstructions": "",
      "category": "SMART_HOME",
      "distributionCountries": [
        "US",
        "GB",
        "DE"
      ]
    },
    "apis": {
      "video": {
        "countries": {
          "US": {
            "catalogInformation": [
              {
                "type": "INGESTED_CONTENT_IDENTIFIER",
                "sourceId": "catalogName"
              },
              {
                "type": "LIVE_TV_MSO",
                "sourceId": "MSOId"
              }
            ]
          }
        },
        "locales": {
          "en-US": {
            "videoProviderTargetingNames": [
              "VideoSampleSkill",
              "TV provider"
            ],
            "features": [
              {
                "version": "1.0",
                "players": [
                  {
                    "logoImageUri": "https://logoImageUri.example.com",
                    "type": "AVS_3P_PROVIDED",
                    "uri": "https://webplayerUri.example.com/index.html",
                    "backgroundImageUri": "https://backgroundImageUri.example.com"
                  }
                ],
                "name": "VIDEO_WEB_PLAYER"
              }
            ]
          }
        },
        "endpoint": {
          "uri": "arn:aws:lambda:us-east-1:452493640596:function:sampleSkill"
        },
        "regions": {
          "NA": {
            "endpoint": {
              "uri": "arn:aws:lambda:us-east-1:452493640596:function:sampleSkill"
            }
          }
        },
        "protocolVersion": "3.0"
      }
    },
    "manifestVersion": "1.0",
    "privacyAndCompliance": {
      "allowsPurchases": false,
      "locales": {
        "en-US": {
          "termsOfUseUrl": "https://www.termsofuse.skill.example.com",
          "privacyPolicyUrl": "https://www.myprivacypolicy.skill.example.com"
        }
      },
      "isExportCompliant": true,
      "isChildDirected": false,
      "usesPersonalInfo": false,
      "containsAds": false
    }
  }
}

Education Skill Manifest

The skill manifest of education skills has the same general format as for other skills, but the apis object includes an education object that contains the objects shown in the following table. For information about education skills, see About Alexa Education Skills.

Field Description Type Required

education.regions

An array of region objects.

Array of region objects

Yes

education.endpoint

An endpoint object that contains a uri, which is the Amazon Resource Name (ARN) of the AWS Lambda function for the skill.

endpoint object

Yes

education.locales

A locales object which, in addition to the fields described in locales, c../smapi/skill-manifest.htmlontains the education.locales.promptName field. The education.locales.promptName field is the name that Alexa uses when speaking the name of your skill to users. For example, "From <promptName>, here are your recently posted grades:…" Currently, education skills support the en-US locale only.

locales object

Yes

education.interfaces

A list of education skill interfaces that the skill supports. For a list of interfaces, see Education skill interfaces.

Array of interface objects

Yes

education.interface.namespace

The name of the education skill interface. An example is Alexa.Education.Course. For a list of interface names, see Education skill interfaces.

string

Yes

education.interface.version

The interface version. Currently 1.0.

string

Yes

education.interface.requests

A list of objects that represent the requests that the education skill supports within the interface.

Array of education.interface.request

Yes

education.interface.requests.name

The request within the interface. Currently, the only request names are Get.

string

Yes

The following is an example of a skill manifest for an education skill.

{
  "manifest": {
    "manifestVersion": "1.0",
    "publishingInformation": {
      "locales": {
        "en-US": {
          "summary": "This is an education skill example.",
          "examplePhrases": [
            "\"Alexa, what are my grades?\"",
            "\"Alexa, what did Hannah do in school today?\""
          ],
          "description": "A skill that keeps students and parents connected to what's going on in school.",
          "keywords": [
            "School",
            "Education"
          ],
          "name": "Example Education Skill",
          "smallIconUri": "iconUri",
          "largeIconUri": "iconUri"
        }
      },
      "isAvailableWorldwide": true,
      "category": "EDUCATION_AND_REFERENCE",
      "testingInstructions": "Alexa, what are my grades?",
      "distributionCountries": [ ]
    },
    "permissions": [
      {
        "name": "alexa::authenticate:2:optional"
      }
    ],
    "apis": {
      "education": {
        "regions": {
          "NA": {
            "endpoint": {
              "uri": "arn:aws:lambda:us-east-1:1234567890:function:ExampleEducationSkill"
            }
          }
        },
        "endpoint": {
          "uri": "arn:aws:lambda:us-east-1:1234567890:function:ExampleEducationSkill"
        },
        "locales": {
          "en-US": {
            "promptName": "Example Education Skill"
          }
        },
        "interfaces": [
          {
            "namespace": "Alexa.Education.Profile.Student",
            "version": "1.0",
            "requests": [
              {
                "name": "Get"
              }
            ]
          },
          {
            "namespace": "Alexa.Education.Course",
            "version": "1.0",
            "requests": [
              {
                "name": "Get"
              }
            ]
          },
          {
            "namespace": "Alexa.Education.Coursework",
            "version": "1.0",
            "requests": [
              {
                "name": "Get"
              }
            ]
          },
          {
            "namespace": "Alexa.Education.Grade.Course",
            "version": "1.0",
            "requests": [
              {
                "name": "Get"
              }
            ]
          },
          {
            "namespace": "Alexa.Education.Grade.Coursework",
            "version": "1.0",
            "requests": [
              {
                "name": "Get"
              }
            ]
          },
          {
            "namespace": "Alexa.Education.School.Communication",
            "version": "1.0",
            "requests": [
              {
                "name": "Get"
              }
            ]
            }
           ]
          }
    },
    "privacyAndCompliance": {
      "locales": {
          "en-US": {
            "privacyPolicyUrl": "https://example.com/privacy"
        }
      },
      "allowsPurchases": false,
      "isExportCompliant": true,
      "containsAds": false,
      "isChildDirected": false,
      "usesPersonalInfo": true
    }
  }
}

Flash Briefing Skill Manifest

{
  "manifest": {
    "manifestVersion": "1.0",
    "publishingInformation": {
      "locales": {
        "en-US": {
          "name": "Sample skill name.",
          "summary": "This is a sample Alexa skill.",
          "description": "This skill has basic and advanced features.",
          "smallIconUri": "https://smallUri.com",
          "largeIconUri": "https://largeUri.com",
          "examplePhrases": [],
          "keywords": [
            "Flash Briefing",
            "News",
            "Happenings"
          ]
        }
      },
      "distributionCountries": [
        "US",
        "GB",
        "DE"
      ],
      "isAvailableWorldwide": false,
      "testingInstructions": "1) Say 'Alexa, hello world'",
      "category": "HEALTH_AND_FITNESS"
    },
    "privacyAndCompliance": {
      "allowsPurchases": false,
      "usesPersonalInfo": false,
      "isChildDirected": false,
      "isExportCompliant": true,
	  "containsAds": false,
      "locales": {
        "en-US": {
          "privacyPolicyUrl": "http://www.myprivacypolicy.sampleskill.com",
          "termsOfUseUrl": "http://www.termsofuse.sampleskill.com"
        }
      }
    },
    "apis": {
      "flashBriefing": {
        "locales": {
          "en-US": {
            "customErrorMessage": "Error message",
            "feeds": [
              {
                "name": "feed name",
                "isDefault": true,
                "vuiPreamble": "In this skill",
                "updateFrequency": "HOURLY",
                "genre": "POLITICS",
                "imageUri": "https://fburi.com",
                "contentType": "TEXT",
                "url": "https://feeds.sampleskill.com/feedX"
              }
            ]
          }
        }
      }
    }
  }
}
Amazon Alexa
Amazon Appstore
Amazon Web Services
Amazon Dash Replenishment