Type

POST

1 curl -X POST https://api.airtop.ai/api/v1/sessions/6aac6f73-bd89-4a76-ab32-5a6c422e8b0b/windows/0334da2a-91b0-42c5-6156-76a5eba87430/type \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "text": "Example text"
6 }'

Play

200Successful

1 {
2   "data": {
3     "modelResponse": "modelResponse"
4   },
5   "meta": {
6     "status": "success",
7     "usage": {
8       "credits": 1000000,
9       "id": "id"
10     },
11     "clientProvided": {
12       "clientRequestId": "clientRequestId"
13     },
14     "requestId": "requestId",
15     "screenshots": [
16       {}
17     ]
18   },
19   "errors": [
20     {
21       "message": "message",
22       "code": "code",
23       "details": {
24         "key": "value"
25       },
26       "reason": "reason"
27     }
28   ],
29   "warnings": [
30     {
31       "message": "message",
32       "code": "code",
33       "details": {
34         "key": "value"
35       },
36       "reason": "reason"
37     }
38   ]
39 }

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.

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.

waitForNavigationbooleanOptional

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

Response

Created

dataobject

metaobject

errorslist of objectsOptional

warningslist of objectsOptional

Path parameters

Headers

Request

Response