v1

latestOpenAPI 3.1.02026-07-133988103.2 KB
windows

Scroll

Execute a scroll interaction in a specific browser window

post/v1/sessions/{sessionId}/windows/{windowId}/scroll

Path parameters

sessionIdstring required

The session id for the window.

windowIdstring required

The Airtop window id of the browser window.

Headers

Authorizationstring required

Bearer authentication

Request body

clientRequestIdstring
costThresholdCreditsinteger

A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is not a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).

scrollToElementstring

A natural language description of where to scroll (e.g. 'the search box', 'username field'). The interaction will be aborted if the target element cannot be found. If provided, scrollToEdge/scrollBy values will be ignored.

scrollWithinstring

A natural language description of the scrollable area on the web page. This identifies the container or region that should be scrolled. If missing, the entire page will be scrolled. You can also describe a visible reference point inside the container. Note: This is different from scrollToElement, which specifies the target element to scroll to. The target may be located inside the scrollable area defined by scrollWithin.

timeThresholdSecondsinteger

A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is not a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).

This setting does not extend the maximum session duration provided at the time of session creation.

Response

Created