Skip to main content
GET
/
accessibility
curl -X GET "http://VM_API_IP:PORT/accessibility"

{
  "role": "application",
  "name": "Desktop",
  "children": [
    {
      "role": "window",
      "name": "Document - Microsoft Word",
      "children": [
        {
          "role": "menu_bar",
          "name": "Menu Bar",
          "children": [
            {
              "role": "menu_item",
              "name": "File"
            },
            {
              "role": "menu_item",
              "name": "Edit"
            }
          ]
        },
        {
          "role": "document",
          "name": "Document Content",
          "value": "Hello, World!"
        }
      ]
    }
  ]
}
Returns the full JSON representation of the UI’s accessibility tree. This is useful for programmatic UI state inspection and understanding the current state of the desktop interface.
Replace VM_API_IP:PORT with the actual IP and port of the VM’s Desktop Environment API server.

​
Response

Returns a JSON representation of the UI accessibility tree. The structure varies by operating system and current application state.
​
[accessibility_tree]
object
Full JSON representation of the UI accessibility tree, containing elements with their roles, names, and hierarchical relationships
curl -X GET "http://VM_API_IP:PORT/accessibility"

{
  "role": "application",
  "name": "Desktop",
  "children": [
    {
      "role": "window",
      "name": "Document - Microsoft Word",
      "children": [
        {
          "role": "menu_bar",
          "name": "Menu Bar",
          "children": [
            {
              "role": "menu_item",
              "name": "File"
            },
            {
              "role": "menu_item",
              "name": "Edit"
            }
          ]
        },
        {
          "role": "document",
          "name": "Document Content",
          "value": "Hello, World!"
        }
      ]
    }
  ]
}