developer documentation
Sign In
Documentation
Forums
Contact Us
Alexa Developer Home
Alexa Developer Console
Alexa Voice Service
Alexa Certification Console
Alexa Connect Kit
Alexa Skills Kit
Alexa Skills Kit
Alexa Presentation Language
Alexa Conversations
Alexa Voice Service
Alexa Connect Kit
Toggle navigation
Toggle navigation
Alexa
>
Documentation
>
Alexa Skills Kit
>
Alexa Skills Kit
Collapse All
|
Expand All
Get Started
What is the Alexa Skills Kit?
About Voice Interaction Models
Index of Skill Types
Create Your Developer Account
Glossary
Skill Types
Automotive Skills
Connected Vehicle Skills
VehicleData
AuthorizationController
Alexa Skills for Driving
Best Practices
Automotive Property
Navigation Management
Alexa Smart Properties
Business
Build Skills for Conferencing Devices
Calendar
MeetingClientController
Create and Publish Private Skills (Developer Console)
Create and Publish Private Skills (ASK CLI)
Meetings Skills
Steps to Create a Meetings Skill
Testing Guide
Reservation.Room
ErrorResponse
Healthcare
Get Started
Policies
About Managing Roles
About Managing Properties and Rooms
About Managing Subscriptions
Manage Skills
Set Up and Manage Devices
Use the Alexa Smart Properties Console
Networking Best Practices
Healthcare REST API Reference
Role API
Property Hierarchy Management API
Endpoint API
Unit Settings API
Skill Management API
Communications API
Notifications API
Paginating Results
Hospitality
Get Started
About Managing Roles
About Managing Properties, Room Types, and Rooms
Manage Skills
Set Up and Manage Devices
Use the Alexa Smart Properties Console
Networking Best Practices
Hospitality REST API Reference
Role API
Property, Room Type, and Room API
Endpoint API
Device Group Management API
Discovery Session API
Unit Settings API
Skill Management API
Communications API
Notifications API
Proactive Suggestion API
Paginating Results
Residential
Get Started
Manage Roles
Manage Homes and Communities
Manage Skills
Set Up and Manage Devices
Residential REST API Reference
Role API
Home and Community API
Endpoint API
Device Group Management API
Discovery Session API
Home Occupancy API
Skill Management API
Paginating Results
Senior Living
Get Started
About Managing Roles
About Managing Properties and Rooms
About Managing Subscriptions
Manage Skills
Set Up and Manage Devices
Use the Alexa Smart Properties Console
Networking Best Practices
Senior Living REST API Reference
Role API
Property Hierarchy Management API
Endpoint API
Device Group Management API
Discovery Session API
Unit Settings API
Skill Management API
Communications API
Notifications API
Proactive Suggestion API
Paginating Results
Cooking Skills
Cooking Interface
FoodTemperatureController
FoodTemperatureSensor
PresetController
TemperatureController
TemperatureSensor
TimeController
TimeHoldController
Property Schemas
Custom Voice Model Skills
Steps to Build a Custom Skill
Get Custom Skill Sample Code
Understand How Users Invoke Custom Skills
Choose the Invocation Name for a Custom Skill
Create a Custom Skill from a Quick Start Template
Host a Custom Skill as an AWS Lambda Function
Host a Custom Skill as a Web Service
Configure a Skill for Multiple Languages
Add Additional Locales of the Same Language to Custom Skills
Use Hindi in Your Alexa Skill
Alexa Skills English Variants Migration FAQ
Alexa Skills French Variants Migration FAQ
Alexa Skills Spanish Variants Migration FAQ
Create the Interaction Model (Intents, Slots, and Dialogs)
Create Intents, Utterances, and Slots
Create and Edit Custom Slot Types
Use Dynamic Entities for Customized Interactions
Collect Multiple Values in a Slot
Improve Sample Utterance Coverage with Recommendations
Best Practices for Sample Utterances and Custom Slot Values
Create the Dialog Model
Validate Slot Values
Use a Dialog Model to Manage Ambiguous Responses
Review the Intent History
Use Built-in Intents and Slot Types
Standard Built-in Intents
Understand the Structure of the Built-in Intent Library
Built-in Intent Library
Actor Intents
Book Intents
BookSeries Intents
Calendar Intents
Catalog Intents
CreativeWork Intents
CreativeWork
Section Intents
Episode Intents
Event Intents
LocalBusiness Intents
MusicCreativeWork Intents
MusicGroup Intents
Musician Intents
MusicPlaylist Intents
MusicRecording Intents
PlaybackMode Intents
ReadingList Intents
ScreeningEvent Intents
Singer Intents
Thing Intents
TVSeason Intents
TVSeries Intents
VideoCreative
Work Intents
VideoPlaylist Intents
WeatherForecast Intents
Slot Type Reference
Migrate Slot Types that Used AMAZON.LITERAL
Entity Resolution
Entity Resolution for Custom Slot Types
Entity Resolution for Built-in Slot types
Alexa Entities Reference
Linked Data API Reference
Handle Requests Sent by Alexa
Manage the Skill Session and Session Attributes
Delegate the Dialog to Alexa
Include a Card in Your Skill's Response
Best Practices for Skill Card Design
Send the User a Progressive Response
Understand Name-free Interaction for Custom Skills
Use the Name-free Interaction Toolkit in the Developer Console
Use the Name-free Interaction Toolkit in CLI
Use the Name-free Interaction Toolkit in SMAPI
Implement CanFulfill
IntentRequest for Name-free Interaction
Personalize the User Experience
Add Personalization to Your Skill
Access the Alexa Shopping and To-Do Lists
Add Personalized Greetings or Prompts
Configure Permissions for Customer Information
Enhance Your Skill with Address Information
Get a User-Specific Access Token for Out-of-Session Calls
Obtain Customer Settings Information
Request Customer Contact Information
Request Recognized Speaker Contact Information
Use Voice-Forward Consent in Your Skill
Add PIN Confirmation to Alexa Skills
Learn Best Practices for Testing Personalization
Use Location Services for Alexa Skills
Use Personalization With or Without Account Linking
Expose Skill Functionality with Tasks
Implement Custom Tasks in Your Skill
Integrate Your Custom Task with Alexa Routines
Implement Amazon Predefined Tasks in Your Skill
Amazon Predefined Task Reference
Let Skills Work Together with Skill Connections
Use Skill Connections to Request Tasks
Alexa Quick Links
Create a Quick Link for Your Custom Skill
Create a Quick Link for Your Custom Task
Use Display Templates to Show Content on Screens
Configure a Skill to Support the Display Interface
Best Practices for using Display Templates
Test for Display Template Issues in Your Skill
Entertainment Device Skills
ChannelController
EqualizerController
InputController
Speaker
StepSpeaker
WakeOnLANController
Flash Briefing Skills
Steps to Create a Flash Briefing Skill
Tips to Create a Great Flash Briefing Skill
Flash Briefing Skill API Feed Reference
Flash Briefing Skill Certification Checklist
Normalize the Loudness of Audio Content
Game Skills
Alexa Web API for Games
Build Your Alexa Skill for Web App Games
Build Your Web App using Web API for Games
Alexa.Presentation.HTML Interface Reference
Add Voice Control and Speech to the Web App
Web API Extensions for Games
Entity-Sensing Extension
Smart-Motion Extension
Release Notes and Known Issues
Alexa JavaScript API
Knowledge Skills
Steps to Create a Knowledge Skill
Knowledge Skill Templates
Custom Knowlege Intents
Knowledge Skill Case Studies
Coffee Shop Skill Case Study
University Skill Case Study
Knowledge Skill FAQ
Troubleshooting Knowledge Skills
Knowledge Skill SMAPI Reference
Knowledge Skill Manifest
Knowledge Skill Operations
List Skills
Steps to Create a List Skill
List Events in Alexa Skills
Creating and Managing List Skills FAQ
Functional Testing for a List Skill
Certification Guidelines for List Skills
Submit an Alexa List Skill for Certification
Music, Radio, and Podcast Skills
Steps to Create a Music, Radio, or Podcast Skill
Implement Podcast Skill Features
Upload Music or Radio Catalogs
Upload Podcast Catalogs
Add Premium Audio, Badging, and License Retrieval to a Music Skill
Internationalize a Podcast Skill
Catalog Reference
Music Catalog Reference
Radio Catalog Reference
Podcast Catalog Reference
Understand Voice Modeling
Testing Guide
Event Subscriptions
Troubleshooting
Music, Radio, and Podcast Skill API
What's New
Audio.PlayQueue
Media.Playback
Media.PlayQueue
Media.Search
UserPreference
API Components Reference
Error Response
Networking and Wi-Fi Skills
HomeNetworkController
ConnectedDevice
AccessController
Smart Home Skills
Steps to Build a Smart Home Skill
Smart Home Skill Concepts
State and Change Reporting
Send Events to the Alexa Event Gateway
Proactively Manage Endpoints
Authenticate a Customer to Alexa
Device Templates
Develop Skills for Multiple Languages
Best Practices for the Alexa App
Bluetooth Mesh Support
Zigbee Support
Migration Guide v2 to v3
Smart Home Skill APIs
BrightnessController
ColorController
ColorTemperatureController
InventoryLevelSensor
InventoryLevelUsageSensor
InventoryUsageSensor
PercentageController
PowerController
PowerLevelController
SceneController
TemperatureSensor
ThermostatController
ThermostatController.Configuration
ThermostatController.Schedule
Generic Controllers
ModeController
RangeController
ToggleController
Smart Home Energy Skills
AutomationManagement
Estimation
Meter
ThermostatController.HVAC.Components
Smart Home Security Skills
CameraStreamController
ContactSensor
DoorbellEventSource
EventDetectionSensor
LockController
MediaMetadata
MotionSensor
Real-Time Communications
RTCSessionController
SecurityPanelController
Multi-capability Skills
Upgrade to MCS with the developer console
Upgrade to MCS with the ASK CLI
Multi-capability skill FAQ
Video Skills
Video Skills for Fire TV Apps
Video Skills for Echo Show
Video Skills for Living Room Devices
Video Skill Testing Guide
Content Catalog Ingestion
Message and Data Formats for Video Skills
State Reporting for Video Skills
Video Skill APIs
KeypadController
Launcher
Playback
Controller
RecordController
RemoteVideo
Player
SeekController
UIController
VideoRecorder
ErrorResponse
Entity Types
Predefined Launch Targets
Skill Development Process
Design Your Skill
Alexa Design Guide
Build Your Skill
Use AI-Driven Dialog Management
Add Visuals and Audio to Your Skill
Add Account Linking
Account Linking Concepts
How Users Experience Account Linking
Requirements for Account Linking
Account Linking Best Practices
Account Linking Quick Reference
Implement Account Linking
Steps to Implement Account Linking
Account Linking for Custom Skills
Account Linking for Smart Home and Other Domains
Configure Account Linking
Configure an Authorization Code Grant
Configure an Implicit Grant (Custom Skills Only)
Let Users Enable Your Skill Without Account Linking
Set up App-to-App Account Linking
App-to-App Account Linking (Starting From Your App)
App-to-App Account Linking (Starting From the Alexa App)
Alexa Skill Activation API
Use Access Tokens in Your Skill Code
Use Access Tokens in Custom Skills
Use Access Tokens in Smart Home, Video, and Meetings Skills
Use Access Tokens in Music Skills
Earn Money with a Skill
Offer Paid Skills
Steps to Implement Paid Skills
Design the Purchase and Cancel Flows
Define Purchase Details
Test Paid Skills
Get Paid for Your Skill
Paid Skills Interface Reference
Sell Premium Content with In-Skill Purchasing
Create and Manage In-Skill Products
Create and Manage In-Skill Products with the ASK CLI
Design a Good Customer Experience
Add ISP Support to Your Skill Code
Choose Pricing, Languages, and Distribution
Build Premium Experiences for Kid Skills in the US
Test In-Skill Purchasing Skills
Certify In-Skill Purchasing Skills
Use In-Skill Product Service APIs
Set Up Payments
In-Skill Purchasing FAQ
Sell Real-World Goods and Services with Amazon Pay
Integrate a Skill with Amazon Pay
Certify your Skill with Amazon Pay
Amazon Pay APIs for Alexa
Payment Declines and Processing Errors
Amazon Pay for Alexa Skills FAQ
Include Reminders in a Skill
Set Up Voice Permissions for Reminders
Alexa Reminders Guidelines
Alexa Reminders API Reference
Add Alexa Shopping Actions to Your Skill
Steps to Add Alexa Shopping Actions to Your Skill
Implement Shopping Actions
Shopping Actions API Reference
Shopping Actions Error Reference
Shopping Actions FAQ
Include Timers in a Skill
Set Up Voice Permissions for Timers
Alexa Timers Guidelines
Alexa Timers API Reference
Use Events in a Skill
Add Events to Your Skill
Send a Message Request to a Skill
Configure an Application or Service to Send Messages to Your Skill
Skill Messaging API Reference
Add Alexa for Apps
Add Alexa for Apps to Your Custom Skill
Skill Manifest Reference
Skill Connection Request Reference
FAQ
Alexa for Apps V1 to V2 Migration Guide
Display Suggestions on the Home Screen
Deprecated Features
Test and Debug Your Skill
Test and Debug Your Smart Home Skill
View Device State
Smart Home Debugger
Smart Home Debugger for WebRTC Skills
Smart Home Test
Test and Debug Your Custom Skill
Configure Your Web Service to Use a Self-Signed Certificate
Set or Get Self-Signed SSL Certificates for Skill Endpoints for Testing
Deploy a Web Service for a Custom Skill to AWS Elastic Beanstalk
Evaluate Automatic Speech Recognition Accuracy
Create an Annotation Set
Run an ASR Evaluation
Improve your Speech Recognition Test Results
Evaluate and Test Your Interaction Model
Find Utterance Conflicts in Your Model
Test Your Utterances as You Build Your Model
Batch Test Your NLU Model
Test with the Alexa Simulator
Beta Test a Skill
Certify and Publish Your Skill
Certification Requirements
Policy Requirements
Security Requirements
Requirements for Skills that Allow Purchases
Requirements for HIPAA-Eligible Skills
Certification Functional Tests
Certification Tests for VUI and UX
Troubleshooting Common Certification Failures
Works with Alexa
WWA Certification Requirements
WWA Security Best Practices
Apply for WWA Certification
WWA Certification Status Tracking
WWA IoT Solution Providers
Works with Alexa FAQ
Certified for Humans
Smart Home Skill Publishing Guide
Monitor Your Skill Metrics and Earnings
Analyze Your Skill Metrics
View Skill Metrics
View Local Analytics (Beta)
Interpret and Troubleshoot Skill Metrics Results
Download Message Ids for Troubleshooting
Skill Metrics FAQ
View Your Payments and Earnings
Skill Rollback
Tools to Create and Manage Skills
Manage Your Developer Account
Alexa Developer Console
Create a Skill and Choose the Interaction Model
Build Your Skill
Define Skill Store Details and Availability
Test and Submit Your Skill for Certification
Alexa-Hosted Skills
Create and Manage Alexa-hosted Skills
Import an Alexa-hosted Skill from a Git Repository
Use Media Files
Use DynamoDB for Data Persistence
Usage Limits on Hosted Resources
Use Personal AWS Resources
Create and Manage Alexa-hosted Skills by Using the ASK CLI
ASK Toolkit for VS Code
Manage Skills in VS Code
APL Documents in VS Code
Test Skills in VS Code
ASK SDKs
ASK SDK for Node.js
Set Up the ASK SDK
Tutorial: Develop Your First Skill
Migration Guide
Processing Request
Building Response
Managing Attributes
Calling Alexa Service APIs
Configuring Skill Instance
Utilities
Call Alexa Service APIs Out of Session
Host a Custom Skill as a Web Service
ASK SDK for Node.js Reference
ASK SDK for Java
Setting Up
Developing Your First Skill
Migration Guide
Supported Capabilities
Request Processing
Skill Attributes
Alexa Service Clients
Response Building
Skill Builders
Managing In-Skill Purchases
Host a Custom Skill as a Web Service
ASK SDK for Java Reference
ASK SDK for Python
Setting Up
Developing Your First Skill
Sample Skills
Supported Capabilities
Request Processing
Response Building
Configuring Skill Instance
Skill Attributes
Alexa Service Clients
Alexa Out-Of-Session Service Clients
Host a Custom Skill as a Web Service
ASK SDK for Python Reference
ASK SDK Deprecation Policy
ASK SDK Controls Framework (Beta)
ASK SDK Controls Framework API Reference
ASK CLI
ASK CLI Quick Start
ASK CLI Reference
Manage Credentials
Migrate from CLI v1 to v2
Skill Management API
Get an Access Token for SMAPI
Account Linking Management
Add Rich Media to Your Skill Detail Page
Audit Logs
Catalog Content Upload
Clone Skill Locale
Intent Request History
Interaction Model Management
In-Skill Product Management
Proactive Events
Metrics
Create a Slot Type to Use in Multiple Skills
Reference-Based Catalog Management
Skill Rollback
Skill Certification and Publishing
Skill Credentials
Skill Enablement
Skill Management
Skill Package Management
Smart Home Evaluation
Vendor Management
Alexa-hosted skill
Manage Update Jobs
SMAPI Error Codes
Skill Testing
Skill Validation
Skill Invocation
Skill Simulation
Skill Beta Testing
Utterance Profiler
NLU Evaluation Tool
Utterance Conflict Detection
Automatic Speech Recognition API Reference
Create an Annotation Set
Delete an Annotation Set
Delete ASR Evaluation
Get Annotation Set Contents
Get Annotation Set Metadata
Get ASR Evaluation Results
Get ASR Evaluation Status
List All Annotation Sets
List ASR Evaluations
Post ASR Evaluation
Update Annotation Set Annotations
Update an Annotation Set Property
API Error Reference
Skill Development Notifications
Skill Development Notifications API Reference
Skill Development Event Schemas
Migration of SMAPI from v0 to v1
AWS Tools
Skill Flow Builder
Reference
Skill Developer Reference
Alexa Interface Reference
List of Alexa Interfaces
Interface Message Guide
Authorization Interface
Discovery Interface
Discovery Objects
Discovery Examples
EndpointHealth Interface
ProactiveNotificationSource Interface
Response Events
ErrorResponse Events
AuthorizationController
Cooking
Safety
SecurityPanelController
ThermostatController
ThermostatController.Configuration
ThermostatController.Schedule
Property Schemas
Resources and Assets
Custom Skill Interface Reference
Request and Response JSON Reference
Request Types Reference
Interfaces
AudioPlayer Interface Reference
Dialog Interface Reference
Display Interface Reference
Display Template Reference
GadgetController Interface Reference
GameEngine Interface Reference
PlaybackController Interface Reference
VideoApp Interface Reference
SSML Reference
Best Practices for Using Amazon Polly Voices
Alexa Skills Kit Sound Library
Speechcons (Interjections)
English (AU)
English (CA)
English (IN)
English (US)
English (UK)
French (CA)
French (FR)
German (DE)
Hindi (IN)
Italian (IT)
Japanese (JP)
Portuguese (BR)
Spanish (MX)
Spanish (ES)
Spanish (US)
Alexa Skills Kit Object Schemas
Skill Manifest Schemas
Skill Manifest Examples
Schema Validation
Account Linking Schemas
Interaction Model Schemas
In-Skill Purchasing Schemas
Paid Skill Schemas
Proactive Events Schemas
About Alexa Smart Properties
This section describes how to build with Alexa Smart Properties.
In this section
Business
Healthcare
Hospitality
Residential
Senior Living
In this section