File Input

Execute a file input interaction in a specific browser window. includeHiddenElements defaults to true and considers hidden file input elements. If there is only one file input element, it will be used directly. If there are multiple file input elements, the elementDescription will be used by AI to select among them. If no file input elements are found by inspecting the page structure, elementDescription will be used by AI to try to find a match visually.

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.
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 the file input to interact with (e.g. ‘the file input’, ‘file upload selection box’). The interaction will be aborted if the target element cannot be found.

fileIdstringOptionalformat: "uuid"
The id of the file to upload. 'fileId' or 'fileName' is required.
fileNamestringOptional
The name of the file to upload, not including the path. 'fileId' or 'fileName' is required.
includeHiddenElementsbooleanOptionalDefaults to true
If true, Airtop AI will find hidden file input elements and interact with them.
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