Skip to main content
GET
/
v1
/
browsers
/
{id}
/
ui-map
Fetch UI Map
curl --request GET \
  --url https://api.example.com/v1/browsers/{id}/ui-map/
[
  {
    "id": 2,
    "name": "New Tab",
    "properties": {
      "Focusable": true,
      "Url": "chrome://new-tab-page/"
    },
    "role": "\"RootWebArea\""
  },
  {
    "id": 16,
    "parent_id": 2,
    "role": "\"none\""
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.rustybrowser.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Returns the accessibility tree (UI map) of the current page as a flat array of nodes. Each node includes its role, name, properties, and parent relationship. Use this to understand the page structure before interacting with elements.

​
Authentication

Authorization: Bearer YOUR_API_KEY
Self-hosted open source deployments do not require authentication.

​
Path Parameters

​
id
string
required
The browser ID returned from Create Session.

​
Response

Returns an array of UI node objects.
​
[].id
integer
Unique node ID within the current page.
​
[].parent_id
integer
ID of the parent node. Absent on the root node.
​
[].name
string
Accessible name of the element.
​
[].role
string
ARIA role of the element (e.g. "RootWebArea", "button", "link").
​
[].properties
object
Additional accessibility properties such as Url, Focusable, Checked, etc.

​
Example

curl https://api.rustybrowser.com/v1/browsers/exc-b9534e98-c3ce-4d1b-9671-b563ac66adc3/ui-map/ \
  -H "Authorization: Bearer YOUR_API_KEY"

[
  {
    "id": 2,
    "name": "New Tab",
    "properties": {
      "Focusable": true,
      "Url": "chrome://new-tab-page/"
    },
    "role": "\"RootWebArea\""
  },
  {
    "id": 16,
    "parent_id": 2,
    "role": "\"none\""
  }
]