About Alexa for Residential

Alexa for Residential provides residents of apartment buildings and communities ready-to-go Alexa-enabled smart homes from the day they move in. When a resident moves into their new home, they find an Alexa device ready to control their lights, thermostat, lock, blinds, and more.

Alexa for Residential provides technologies that smart home solution integrators can use to deploy, manage, and service Alexa devices in residential buildings and communities. It provides Alexa APIs for device fleet management for residential properties. You can use these APIs to build Alexa capabilities into installation tools and management software. With these APIs, you can set up a whole smart community at scale with Alexa and directly integrate it with property management and smart home solutions. These solutions enable property owners and managers to administer Alexa devices when units are vacant and securely switch over devices when a home changes residents.

For an overview of features and benefits, as well as how to sign up for the Alexa for Residential program, see Alexa for Residential.

Alexa for Residential defines the following key concepts and terms for managing homes and communities:

Units

A unit represents a node in a hierarchy. A unit can be an organization, a home community, or a home. In Alexa for Residential, you create a hierarchy of units to model home communities and individual homes by using the Home and Community API.

Home communities

A home community is a collection of homes. An apartment building is a home community and each apartment in the building is a home. A garden style apartment complex is a home community made up of several buildings and each apartment in each building is a home. A single-family home suburban subdivision is a home community and each single-family home is a singular home. This model allows Alexa for Residential to be extensible and accommodate different types of homes.

Homes

A home is a household dwelling that a customer occupies. A home can be an apartment, condo, senior housing unit, dorm, or single-family home. Alexa endpoints (devices) and skills are associated with individual homes.

Endpoints

An endpoint represents an Alexa-connected device (like an Echo device) with which an Alexa customer can interact. In Alexa for Residential, you manage endpoints by using the Endpoint API. With this API, you can enumerate the endpoints owned by an Amazon Business account, view and change endpoint settings, and associate endpoints with specific homes.

Alexa for Residential REST APIs

Alexa for Residential provides the following APIs.

REST API Description

Role API

Assigns roles to users.

Home and Community API

Manages homes and communities.

Endpoint API

Provides endpoint information for each device that's registered to your Alexa Business account.

Home Occupancy API

Manages the process of moving in and out of homes.

Skill Management API

Manages skill settings for homes.

To get started with Alexa for Residential APIs, see Get Started with Alexa for Residential APIs.