Airtop APIWindows

Type

Execute a type interaction in a specific browser window

Path parameters

sessionIdstringRequired
The session id for the window.
windowIdstringRequired
The Airtop window id of the browser window.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
textstringRequired
The text to type into the browser window.
clearInputFieldbooleanOptional
If true, and an HTML input field is active, clears the input field before typing the text.
clientRequestIdstringOptional
configurationobjectOptional
Request configuration
costThresholdCreditslongOptional

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

elementDescriptionstringOptional

A natural language description of where to type (e.g. ‘the search box’, ‘username field’). The interaction will be aborted if the target element cannot be found.

pressEnterKeybooleanOptional
If true, simulates pressing the Enter key after typing the text.
pressTabKeybooleanOptional
If true, simulates pressing the Tab key after typing the text. Note that the tab key will be pressed after the Enter key if both options are configured.
timeThresholdSecondslongOptional

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.

waitForNavigationbooleanOptionalDefaults to false
If true, Airtop AI will wait for the navigation to complete after clicking the element.

Response

Created
dataobject
metaobject
errorslist of objects or null
warningslist of objects or null