v1

latestOpenAPI 3.1.02026-07-133988103.2 KB
windows

Get window info

Get information about a browser window in a session, including the live view url.

get/v1/sessions/{sessionId}/windows/{windowId}

Path parameters

sessionIdstring required

ID of the session that owns the window.

windowIdstring required

ID of the browser window, which can either be a normal AirTop windowId or a CDP TargetId from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.

Query parameters

includeNavigationBarboolean

Affects the live view configuration. A navigation bar is not shown in the live view of a browser by default. Set this to true to configure the returned liveViewUrl so that a navigation bar is rendered, allowing users to easily navigate the browser to other pages from the live view.

disableResizeboolean

Affects the live view configuration. Set to true to configure the returned liveViewUrl so that the ability to resize the browser window from the live view is disabled (resizing is allowed by default). Note that, at initial load, the live view will automatically fill the parent frame (or local window if loaded directly) and cause the browser window to be resized to match. This parameter does not affect that initial load behavior. See screenResolution for a way to set a fixed size for the live view.

screenResolutionstring

Affects the live view configuration. By default, a live view will fill the parent frame (or local window if loaded directly) when initially loaded, causing the browser window to be resized to match. This parameter can be used to instead configure the returned liveViewUrl so that the live view is loaded with fixed dimensions (e.g. 1280x720), resizing the browser window to match, and then disallows any further resizing from the live view.

Headers

Authorizationstring required

Bearer authentication

Response

Created