Google

HomeGraph API

HomeGraph API endpoints from Google

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

HomeGraph API endpoints from Google

Endpoints 5

agentUsers

  • DELETEUnlinks the given third-party user from your smart home Action/v1/:agentUserId?requestId=stringUnlinks the given third-party user from your smart home Action. All data related to this user will be deleted. For more details on how users link their…

devices

  • POSTGets the current states in Home Graph for the given set of the third-party user's devices/v1/devices:queryGets the current states in Home Graph for the given set of the third-party user's devices. The third-party user's identity is passed in via the agent_user_id…
  • POSTReports device state and optionally sends device notifications/v1/devices:reportStateAndNotificationReports device state and optionally sends device notifications. Called by your smart home Action when the state of a third-party device changes or you need to…
  • POSTRequests Google to send an `action.devices.SYNC`…/v1/devices:requestSyncRequests Google to send an action.devices.SYNC intent to your smart home Action to update device metadata for the given user. The third-party user's identity…
  • POSTGets all the devices associated with the given third-party user/v1/devices:syncGets all the devices associated with the given third-party user. The third-party user's identity is passed in via the agent_user_id (see SyncRequest). This…

API details

Base URL
https://homegraph.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
5 operations on 5 pathsPOST 4DELETE 1
Main resources
devices 4agentUsers 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the HomeGraph API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the HomeGraph API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Unlinks the given third-party user from your smart home Action” (DELETE /v1/:agentUserId?requestId=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the HomeGraph API?

HomeGraph API endpoints from Google It is listed under Developer tools and has 5 endpoints.

Who publishes the HomeGraph API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the HomeGraph API?

Requests go to https://homegraph.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the HomeGraph API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the HomeGraph API have?

5 operations on 5 paths (4 POST, 1 DELETE). The largest groups are devices, agentUsers.

Is forking the HomeGraph API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.