HomeGraph API

Service: homegraph.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://homegraph.googleapis.com

REST Resource: v1.agentUsers

delete DELETE /v1/{agentUserId=agentUsers/**}
Unlinks the given third-party user from your smart home Action.

REST Resource: v1.devices

query POST /v1/devices:query
Gets the current states in Home Graph for the given set of the third-party user's devices.
reportStateAndNotification POST /v1/devices:reportStateAndNotification
Reports device state and optionally sends device notifications.
requestSync POST /v1/devices:requestSync
Requests Google to send an action.devices.SYNC intent to your smart home Action to update device metadata for the given user.
sync POST /v1/devices:sync
Gets all the devices associated with the given third-party user.