Skip to main content
GET
Fetch UI Map

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

Open-source deployments do not require authentication by default. If your server config enables X-API-Key, include that header with the request.

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, such as "RootWebArea", "button", or "link".
[].properties
object
Additional accessibility properties such as Url, Focusable, Checked, etc.

Example