Introduction
Overview
The Aqara Studio API provides a comprehensive set of interfaces that support you to efficiently and securely access and manage data related to devices, spaces, and automation within Aqara Studio.
With these APIs, you can list spaces and devices, control devices remotely, read and write trait values, and create, query, update, and delete automation rules.
Whether you are managing devices or building automation scenarios, the Studio API provides the essential capabilities needed to quickly integrate and extend Aqara platform data and services.
HTTP API List
Before reading each HTTP API document, please make sure you have read the following documents:
- Getting Started with the HTTP API: Understand the key elements of Aqara Studio HTTP API requests (HTTP method, endpoint, headers, authentication, parameters) and responses (status codes, response body).
- Try HTTP API Online: Learn how to conveniently test and verify API functions online from the documentation page.
- Test API with Postman: Learn how to use Postman to debug Aqara Studio APIs.
Space
| Name | API Endpoint | HTTP Method |
|---|---|---|
| List Spaces | /open/api/v1/spaces | GET |
| Create Space | /open/api/v1/spaces | POST |
| Update Space Name | /open/api/v1/spaces/name | POST |
Gateway
| Name | API Endpoint | HTTP Method |
|---|---|---|
| List Gateways | /open/api/v1/gateways | GET |
| Gateway Joins Subdevice | /open/api/v1/gateways/subdevices/join | POST |
| Stop Gateway Subdevice Join | /open/api/v1/gateways/subdevices/join/stop | POST |
| Get Device Bind Result | /open/api/v1/gateways/subdevices/bindResult | POST |
Device
| Name | API Endpoint | HTTP Method |
|---|---|---|
| List Device Types | /open/api/v1/devices/types | GET |
| List Devices | /open/api/v1/devices | GET |
| Query Device Model Definition | /open/api/v1/devices/definitions | GET |
| Control Devices by Traits | /open/api/v1/devices/trait/execute | POST |
| Query Trait Values | /open/api/v1/devices/trait/read | POST |
| Control Devices by Commands | /open/api/v1/devices/command/execute | POST |
| Send Command to Device and Wait for Response | /open/api/v1/devices/command/execute/await | POST |
| Delete A Function | /open/api/v1/devices/points/delete | POST |
| Add A Virtual Device | /open/api/v1/virtual-devices | POST |
| Unbind A Device | /open/api/v1/devices/unbind | POST |
Automation
| Name | API Endpoint | HTTP Method |
|---|---|---|
| List Automation Capabilities | /open/api/v1/automations/capabilities | GET |
| Create Automation | /open/api/v1/automations | POST |
| List Automations | /open/api/v1/automations | GET |
| Query Automation Details | /open/api/v1/automations/<automationId> | GET |
| Edit Automation | /open/api/v1/automations/<automationId> | PATCH |
| Batch Update Automation Status | /open/api/v1/automations/status | POST |
| Batch Update Automation Space | /open/api/v1/automations/space | POST |
| Delete Automations | /open/api/v1/automations/delete | POST |
| Get Manual Trigger List | /open/api/v1/automations/manual-triggers | GET |
| Execute Manual Trigger | /open/api/v1/automations/manual-triggers/execute | POST |
Studio
| Name | API Endpoint | HTTP Method |
|---|---|---|
| Get Studio Statistics | /open/api/v1/studio/statistics | GET |
WebSocket API
In addition to HTTP API, Aqara Studio also provides WebSocket-based subscription and push capabilities, suitable for receiving real-time trait value changes and object events. If you want to test connection, authentication, heartbeat, and subscription processes directly within the documentation, please visit the WebSocket API Playground.