v1

latestOpenAPI 3.1.02026-07-133988103.2 KB
windows

Monitor for a condition

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

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
conditionstring required

A natural language description of the condition to monitor for in the browser window.

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).

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