Devices
Get device UI state
Captures the current UI tree and screen dimensions. The a11yTree
field carries the formatted element tree (with 1-based interactive
indices) used by POST /tap { index }.
On a Lusor Phone, an API-key read meters phone minutes like any other direct action.
GET
/
v1
/
workspaces
/
{workspaceId}
/
devices
/
{deviceId}
/
state
Get device UI state
curl --request GET \
--url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/state \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/state', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/state"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"deviceId": "<string>",
"phoneState": {},
"deviceContext": {
"screenWidth": 123,
"screenHeight": 123,
"interactiveCount": 123,
"elementCount": 123
},
"a11yTree": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
ApiKeyBearerAuth
Workspace API key, created in the dashboard under Settings → API Keys.
Path Parameters
Workspace UUID. Caller must have access.
Device id (paired into the workspace).
Response
Device state
Show child attributes
Show child attributes
Formatted UI element tree with 1-based interactive indices.
Use [N] in POST /tap { index: N } to tap the Nth
interactive element. On an iPhone it is the iOS
accessibility tree, each frame {{x, y}, {width, height}}
in points, and [N] taps the centre of that frame.
Was this page helpful?
⌘I
Get device UI state
curl --request GET \
--url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/state \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/state', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/state"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"deviceId": "<string>",
"phoneState": {},
"deviceContext": {
"screenWidth": 123,
"screenHeight": 123,
"interactiveCount": 123,
"elementCount": 123
},
"a11yTree": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}