Alexa Voice Service (AVS) API Reference Overview

This page provides and overview and links to reference documentation for the cloud-based APIs offered by the Alexa Voice Service (AVS).


Use the Alerts interface to set and manage locally stored timers, alarms, and reminders.

» Alerts API reference


Use the Alexa interface for centralized message management and state and error reporting for other capability interfaces.

» Alexa API reference


Use the Alexa.ApiGateway interface to coordinate URI endpoints when exchanging messages with Alexa services.

» Alexa.ApiGateway reference


Use the AudioActivityTracker interface to report to Alexa about on-device audio activities.

» AudioActivityTracker


Use the AudioPlayer interface for fetching, playing, and managing audio streams.

» AudioPlayer reference


Use the Bluetooth interface to establish and manage connections with external Bluetooth devices.

» Bluetooth reference


Use the Alexa.Camera.LiveViewController interface to enable live feed video stream to a viewing device from a security camera.

» Alexa.Camera.LiveViewController reference


Use the Alexa.Discovery interface to report capabilities, connection information, and other metadata for Alexa devices and connected endpoints.

» Alexa.Discovery reference


Use the Alexa.Display interface to report physical characteristics of two-dimensional video display devices.

» Alexa.Display reference


Use the Alexa.Display.Window interface to report the characteristics of potential windows that you might create on the physical display of a device.

» Alexa.Display.Window reference


Use the Alexa.DoNotDisturb (DND) interface to disable incoming notifications, announcements, and calls.

» Alexa.DoNotDisturb reference


Use the EqualizerController interface to set the equalizer values for speaker output.

» EqualizerController reference


Use the Alexa.InputController interface to set the active audio or video input for a device.

» Alexa.InputController reference


Use the Alexa.InteractionMode interface to report the supported user interaction paradigms of a device, such as a "tablet mode" or an "auto head unit mode."

To learn more about using Alexa APIs for multimodal experiences, see Alexa Multimodal API Overview.

» Alexa.InteractionMode reference


Use the InteractionModel interface to publish updates to the device interaction model, for example, enabling Alexa-initiated experiences such as Routines.

» InteractionModel reference


For your device's predefined list of states of points states the states, use the Alexa.ModeController interface for controlling and reporting the states of those endpoints.

» Alexa.ModeController reference


Use the Notifications interface to provide users with audio and visual indicators of new available content from Alexa skills.

» Notifications reference


Use the PlaybackController interface to communicate locally triggered playback state changes on a device to Alexa, such as user pausing playback by pressing a button.

» PlaybackController reference


Use the Alexa.ModeController interface to control and report the binary power state of an endpoint.

» Alexa.PowerController reference


Use the Alexa.Presentation interface to define common visual presentation behaviors, such as reporting device-side lifecycle updates to Alexa.

» Alexa.Presentation reference


Use the Alexa.Presentation.APL interface to render Alexa Presentation Language (APL) visual content and report user interactions.

To learn more about APL, see Alexa Multimodal API Overview.

» PlaybackController reference


Use the Alexa.Presentation.APL.Video interface to report the codecs that a device supports for video content in APL documents.

To learn more about APL, see Alexa Multimodal API Overview.

» Alexa.Presentation.APL.Video reference


Use the Alexa.RangeController interface to control and report the states of an endpoint when the endpoint states are from an explicitly defined continuous numeric range.

» Alexa.RangeController reference


Use the Settings interface to manage device locale settings.

» Settings reference


Use the Alexa.SoftwareComponentReporter interface to report software information to AVS.

» Alexa.SoftwareComponentReporter reference


Use the Speaker interface to manage a device's physical speaker volume and mute settings.

» Speaker reference


Use the SpeechRecognizer interface to capture and interact with user speech through a device's microphone.

» SpeechRecognizer reference


Use the SpeechSynthesizer interface for playback of synthesized speech from Alexa.

» SpeechSynthesizer reference


The System interface exposes functionality related to the basic system-level operation of an Alexa Built-in device.

» System reference


Use the TemplateRuntime interface to render display cards created from templates that accompany voice interactions, music playback, and other user experiences.

» TemplateRuntime reference


Use the Alexa.ToggleController interface to control and report the binary "on" or "off" states of an endpoint.

» Alexa.ToggleController reference


Use the VisualActivityTracker interface to communicate to Alexa about on-device visual activities.

» VisualActivityTracker reference

Last updated: Jan 07, 2022