Sign in

v1

latestOpenAPI 3.1.02026-07-133988103.2 KB
windows

Create window

Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.

post/v1/sessions/{sessionId}/windows

Path parameters

sessionIdstring required

ID of the session that owns the window.

Headers

Authorizationstring required

Bearer authentication

Request body

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.

urlstring uri

Initial url to navigate to

waitUntil'load' | 'domContentLoaded' | 'complete' | 'noWait'

Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately.

waitUntilTimeoutSecondsinteger

Maximum time in seconds to wait for the specified loading event to occur. If the timeout is reached, the operation will still succeed but return a warning indicating the page may still be loading resources.

Response

Created