---
title: "UI state"
method: GET
path: "/devices/{deviceId}/ui-state"
tags: ["Tools"]
---

# UI state

`GET /devices/{deviceId}/ui-state`

## Path parameters

- `deviceId` string, required

## Query parameters

- `filter` boolean

## Headers

- `X-Device-Display-ID` integer

## Response `200`

OK

- AndroidState
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `a11y_tree` A11YNode, required
    - `boundsInScreen` A11YBounds, required
      - `bottom` integer, required
      - `left` integer, required
      - `right` integer, required
      - `top` integer, required
    - `children` A11YNode[], nullable, required
    - `className` string, required
    - `contentDescription` string, required
    - `isCheckable` boolean, required
    - `isChecked` boolean, required
    - `isClickable` boolean, required
    - `isEnabled` boolean, required
    - `isFocusable` boolean, required
    - `isFocused` boolean, required
    - `isLongClickable` boolean, required
    - `isPassword` boolean, required
    - `isScrollable` boolean, required
    - `isSelected` boolean, required
    - `packageName` string, required
    - `resourceId` string, required
    - `text` string, required
  - `device_context` DeviceContext, required
    - `display_metrics` DisplayMetrics, required
      - `density` number, double, required
      - `densityDpi` integer, required
      - `heightPixels` integer, required
      - `scaledDensity` number, double, required
      - `widthPixels` integer, required
    - `filtering_params` FilteringParams, required
      - `min_element_size` integer, required
      - `overlay_offset` integer, required
    - `screen_bounds` Rect, required
      - `height` integer, required
      - `width` integer, required
  - `ime_tree` A11YNode, required
    - `boundsInScreen` A11YBounds, required
      - `bottom` integer, required
      - `left` integer, required
      - `right` integer, required
      - `top` integer, required
    - `children` A11YNode[], nullable, required
    - `className` string, required
    - `contentDescription` string, required
    - `isCheckable` boolean, required
    - `isChecked` boolean, required
    - `isClickable` boolean, required
    - `isEnabled` boolean, required
    - `isFocusable` boolean, required
    - `isFocused` boolean, required
    - `isLongClickable` boolean, required
    - `isPassword` boolean, required
    - `isScrollable` boolean, required
    - `isSelected` boolean, required
    - `packageName` string, required
    - `resourceId` string, required
    - `text` string, required
  - `phone_state` PhoneState, required
    - `activityName` string
    - `currentApp` string
    - `focusedElement` PhoneStateFocusedElementStruct
      - `className` string
      - `resourceId` string
      - `text` string
    - `isEditable` boolean, required
    - `keyboardVisible` boolean, required
    - `packageName` string

## Other responses

- `default` — Error

---

[API](https://skmtc.net/droidrun/apis/droidrun-cloud.md) · [All operations](https://skmtc.net/droidrun/apis/droidrun-cloud/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/droidrun/droidrun-cloud/versions/7f577998739b/schema)