@airtop/sdk 0.1.40 → 0.1.41-beta0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -10
- package/api/resources/automations/client/Client.js +4 -4
- package/api/resources/files/client/Client.d.ts +11 -0
- package/api/resources/files/client/Client.js +52 -4
- package/api/resources/files/client/requests/PushFileBodyV1.d.ts +11 -0
- package/api/resources/files/client/requests/PushFileBodyV1.js +5 -0
- package/api/resources/files/client/requests/index.d.ts +1 -0
- package/api/resources/profiles/client/Client.js +1 -1
- package/api/resources/requests/client/Client.js +1 -1
- package/api/resources/sessions/client/Client.js +6 -6
- package/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
- package/api/resources/sessions/types/index.d.ts +1 -1
- package/api/resources/sessions/types/index.js +1 -1
- package/api/resources/windows/client/Client.d.ts +228 -0
- package/api/resources/windows/client/Client.js +1162 -201
- package/api/resources/windows/client/requests/ActRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/ActRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncFileInputRequest.d.ts +33 -0
- package/api/resources/windows/client/requests/AsyncFileInputRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
- package/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
- package/api/resources/windows/client/requests/ExtractRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/ExtractRequest.js +5 -0
- package/api/resources/windows/client/requests/FindManyRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/FindManyRequest.js +5 -0
- package/api/resources/windows/client/requests/FindOneRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/FindOneRequest.js +5 -0
- package/api/resources/windows/client/requests/LlmRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/LlmRequest.js +5 -0
- package/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +25 -0
- package/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
- package/api/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +31 -0
- package/api/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +17 -0
- package/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
- package/api/types/AsyncOperatorPromptResponseEnvelope.js +5 -0
- package/api/types/FileEventMessage.d.ts +1 -0
- package/api/types/index.d.ts +1 -0
- package/api/types/index.js +1 -0
- package/dist/api/resources/automations/client/Client.js +4 -4
- package/dist/api/resources/files/client/Client.d.ts +11 -0
- package/dist/api/resources/files/client/Client.js +52 -4
- package/dist/api/resources/files/client/requests/PushFileBodyV1.d.ts +11 -0
- package/dist/api/resources/files/client/requests/PushFileBodyV1.js +5 -0
- package/dist/api/resources/files/client/requests/index.d.ts +1 -0
- package/dist/api/resources/profiles/client/Client.js +1 -1
- package/dist/api/resources/requests/client/Client.js +1 -1
- package/dist/api/resources/sessions/client/Client.js +6 -6
- package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
- package/dist/api/resources/sessions/types/index.d.ts +1 -1
- package/dist/api/resources/sessions/types/index.js +1 -1
- package/dist/api/resources/windows/client/Client.d.ts +228 -0
- package/dist/api/resources/windows/client/Client.js +1162 -201
- package/dist/api/resources/windows/client/requests/ActRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/ActRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncFileInputRequest.d.ts +33 -0
- package/dist/api/resources/windows/client/requests/AsyncFileInputRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/ExtractRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/ExtractRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/FindManyRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/FindManyRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/FindOneRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/FindOneRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/LlmRequest.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/LlmRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +31 -0
- package/dist/api/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +17 -0
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.js +5 -0
- package/dist/api/types/FileEventMessage.d.ts +1 -0
- package/dist/api/types/index.d.ts +1 -0
- package/dist/api/types/index.js +1 -0
- package/dist/serialization/resources/files/client/requests/PushFileBodyV1.d.ts +12 -0
- package/dist/serialization/resources/files/client/requests/PushFileBodyV1.js +43 -0
- package/dist/serialization/resources/files/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/files/client/requests/index.js +3 -1
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
- package/dist/serialization/resources/sessions/types/index.d.ts +1 -1
- package/dist/serialization/resources/sessions/types/index.js +1 -1
- package/dist/serialization/resources/windows/client/requests/ActRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/ActRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFileInputRequest.d.ts +22 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFileInputRequest.js +53 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
- package/dist/serialization/resources/windows/client/requests/ExtractRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/ExtractRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/FindManyRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/FindManyRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/FindOneRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/FindOneRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/LlmRequest.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/LlmRequest.js +48 -0
- package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
- package/dist/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js +51 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/index.js +35 -1
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
- package/dist/serialization/types/FileEventMessage.d.ts +1 -0
- package/dist/serialization/types/FileEventMessage.js +1 -0
- package/dist/serialization/types/index.d.ts +1 -0
- package/dist/serialization/types/index.js +1 -0
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.js +1 -0
- package/dist/utils/upload.d.ts +13 -0
- package/dist/utils/upload.js +55 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AirtopClient.js +1 -1
- package/dist/wrapper/AirtopFiles.js +3 -3
- package/dist/wrapper/AirtopSessions.d.ts +24 -0
- package/dist/wrapper/AirtopSessions.js +103 -0
- package/dist/wrapper/AirtopWindows.d.ts +25 -1
- package/dist/wrapper/AirtopWindows.js +23 -1
- package/package.json +1 -1
- package/reference.md +1492 -108
- package/serialization/resources/files/client/requests/PushFileBodyV1.d.ts +12 -0
- package/serialization/resources/files/client/requests/PushFileBodyV1.js +43 -0
- package/serialization/resources/files/client/requests/index.d.ts +1 -0
- package/serialization/resources/files/client/requests/index.js +3 -1
- package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
- package/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
- package/serialization/resources/sessions/types/index.d.ts +1 -1
- package/serialization/resources/sessions/types/index.js +1 -1
- package/serialization/resources/windows/client/requests/ActRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/ActRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncFileInputRequest.d.ts +22 -0
- package/serialization/resources/windows/client/requests/AsyncFileInputRequest.js +53 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
- package/serialization/resources/windows/client/requests/ExtractRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/ExtractRequest.js +50 -0
- package/serialization/resources/windows/client/requests/FindManyRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/FindManyRequest.js +50 -0
- package/serialization/resources/windows/client/requests/FindOneRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/FindOneRequest.js +50 -0
- package/serialization/resources/windows/client/requests/LlmRequest.d.ts +17 -0
- package/serialization/resources/windows/client/requests/LlmRequest.js +48 -0
- package/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +17 -0
- package/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
- package/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +20 -0
- package/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js +51 -0
- package/serialization/resources/windows/client/requests/index.d.ts +17 -0
- package/serialization/resources/windows/client/requests/index.js +35 -1
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
- package/serialization/types/FileEventMessage.d.ts +1 -0
- package/serialization/types/FileEventMessage.js +1 -0
- package/serialization/types/index.d.ts +1 -0
- package/serialization/types/index.js +1 -0
- package/utils/index.d.ts +1 -0
- package/utils/index.js +1 -0
- package/utils/upload.d.ts +13 -0
- package/utils/upload.js +55 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AirtopClient.js +1 -1
- package/wrapper/AirtopFiles.js +3 -3
- package/wrapper/AirtopSessions.d.ts +24 -0
- package/wrapper/AirtopSessions.js +103 -0
- package/wrapper/AirtopWindows.d.ts +25 -1
- package/wrapper/AirtopWindows.js +23 -1
package/reference.md
CHANGED
@@ -2,6 +2,87 @@
|
|
2
2
|
|
3
3
|
## Windows
|
4
4
|
|
5
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncClick</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
6
|
+
<dl>
|
7
|
+
<dd>
|
8
|
+
|
9
|
+
#### 📝 Description
|
10
|
+
|
11
|
+
<dl>
|
12
|
+
<dd>
|
13
|
+
|
14
|
+
<dl>
|
15
|
+
<dd>
|
16
|
+
|
17
|
+
Execute a click interaction in a specific browser window asynchronously
|
18
|
+
|
19
|
+
</dd>
|
20
|
+
</dl>
|
21
|
+
</dd>
|
22
|
+
</dl>
|
23
|
+
|
24
|
+
#### 🔌 Usage
|
25
|
+
|
26
|
+
<dl>
|
27
|
+
<dd>
|
28
|
+
|
29
|
+
<dl>
|
30
|
+
<dd>
|
31
|
+
|
32
|
+
```typescript
|
33
|
+
await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
34
|
+
elementDescription: "The login button",
|
35
|
+
});
|
36
|
+
```
|
37
|
+
|
38
|
+
</dd>
|
39
|
+
</dl>
|
40
|
+
</dd>
|
41
|
+
</dl>
|
42
|
+
|
43
|
+
#### ⚙️ Parameters
|
44
|
+
|
45
|
+
<dl>
|
46
|
+
<dd>
|
47
|
+
|
48
|
+
<dl>
|
49
|
+
<dd>
|
50
|
+
|
51
|
+
**sessionId:** `string` — The session id for the window.
|
52
|
+
|
53
|
+
</dd>
|
54
|
+
</dl>
|
55
|
+
|
56
|
+
<dl>
|
57
|
+
<dd>
|
58
|
+
|
59
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
60
|
+
|
61
|
+
</dd>
|
62
|
+
</dl>
|
63
|
+
|
64
|
+
<dl>
|
65
|
+
<dd>
|
66
|
+
|
67
|
+
**request:** `Airtop.AsyncClickRequest`
|
68
|
+
|
69
|
+
</dd>
|
70
|
+
</dl>
|
71
|
+
|
72
|
+
<dl>
|
73
|
+
<dd>
|
74
|
+
|
75
|
+
**requestOptions:** `Windows.RequestOptions`
|
76
|
+
|
77
|
+
</dd>
|
78
|
+
</dl>
|
79
|
+
</dd>
|
80
|
+
</dl>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
</details>
|
85
|
+
|
5
86
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
6
87
|
<dl>
|
7
88
|
<dd>
|
@@ -251,6 +332,87 @@ await client.windows.asyncExecuteAutomation(
|
|
251
332
|
</dl>
|
252
333
|
</details>
|
253
334
|
|
335
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFileInput</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
336
|
+
<dl>
|
337
|
+
<dd>
|
338
|
+
|
339
|
+
#### 📝 Description
|
340
|
+
|
341
|
+
<dl>
|
342
|
+
<dd>
|
343
|
+
|
344
|
+
<dl>
|
345
|
+
<dd>
|
346
|
+
|
347
|
+
Execute a file input interaction in a specific browser window asynchronously
|
348
|
+
|
349
|
+
</dd>
|
350
|
+
</dl>
|
351
|
+
</dd>
|
352
|
+
</dl>
|
353
|
+
|
354
|
+
#### 🔌 Usage
|
355
|
+
|
356
|
+
<dl>
|
357
|
+
<dd>
|
358
|
+
|
359
|
+
<dl>
|
360
|
+
<dd>
|
361
|
+
|
362
|
+
```typescript
|
363
|
+
await client.windows.asyncFileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
364
|
+
elementDescription: "The file input in the bottom left corner",
|
365
|
+
});
|
366
|
+
```
|
367
|
+
|
368
|
+
</dd>
|
369
|
+
</dl>
|
370
|
+
</dd>
|
371
|
+
</dl>
|
372
|
+
|
373
|
+
#### ⚙️ Parameters
|
374
|
+
|
375
|
+
<dl>
|
376
|
+
<dd>
|
377
|
+
|
378
|
+
<dl>
|
379
|
+
<dd>
|
380
|
+
|
381
|
+
**sessionId:** `string` — The session id for the window.
|
382
|
+
|
383
|
+
</dd>
|
384
|
+
</dl>
|
385
|
+
|
386
|
+
<dl>
|
387
|
+
<dd>
|
388
|
+
|
389
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
390
|
+
|
391
|
+
</dd>
|
392
|
+
</dl>
|
393
|
+
|
394
|
+
<dl>
|
395
|
+
<dd>
|
396
|
+
|
397
|
+
**request:** `Airtop.AsyncFileInputRequest`
|
398
|
+
|
399
|
+
</dd>
|
400
|
+
</dl>
|
401
|
+
|
402
|
+
<dl>
|
403
|
+
<dd>
|
404
|
+
|
405
|
+
**requestOptions:** `Windows.RequestOptions`
|
406
|
+
|
407
|
+
</dd>
|
408
|
+
</dl>
|
409
|
+
</dd>
|
410
|
+
</dl>
|
411
|
+
|
412
|
+
</dd>
|
413
|
+
</dl>
|
414
|
+
</details>
|
415
|
+
|
254
416
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
255
417
|
<dl>
|
256
418
|
<dd>
|
@@ -332,11 +494,11 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
332
494
|
</dl>
|
333
495
|
</details>
|
334
496
|
|
335
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
497
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
336
498
|
<dl>
|
337
499
|
<dd>
|
338
500
|
|
339
|
-
####
|
501
|
+
#### 🔌 Usage
|
340
502
|
|
341
503
|
<dl>
|
342
504
|
<dd>
|
@@ -344,13 +506,64 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
344
506
|
<dl>
|
345
507
|
<dd>
|
346
508
|
|
347
|
-
|
509
|
+
```typescript
|
510
|
+
await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
511
|
+
elementDescription: "The search box input in the top right corner",
|
512
|
+
});
|
513
|
+
```
|
514
|
+
|
515
|
+
</dd>
|
516
|
+
</dl>
|
517
|
+
</dd>
|
518
|
+
</dl>
|
519
|
+
|
520
|
+
#### ⚙️ Parameters
|
521
|
+
|
522
|
+
<dl>
|
523
|
+
<dd>
|
524
|
+
|
525
|
+
<dl>
|
526
|
+
<dd>
|
527
|
+
|
528
|
+
**sessionId:** `string` — The session id for the window.
|
529
|
+
|
530
|
+
</dd>
|
531
|
+
</dl>
|
532
|
+
|
533
|
+
<dl>
|
534
|
+
<dd>
|
535
|
+
|
536
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
537
|
+
|
538
|
+
</dd>
|
539
|
+
</dl>
|
540
|
+
|
541
|
+
<dl>
|
542
|
+
<dd>
|
543
|
+
|
544
|
+
**request:** `Airtop.AsyncHoverRequest`
|
545
|
+
|
546
|
+
</dd>
|
547
|
+
</dl>
|
548
|
+
|
549
|
+
<dl>
|
550
|
+
<dd>
|
551
|
+
|
552
|
+
**requestOptions:** `Windows.RequestOptions`
|
348
553
|
|
349
554
|
</dd>
|
350
555
|
</dl>
|
351
556
|
</dd>
|
352
557
|
</dl>
|
353
558
|
|
559
|
+
</dd>
|
560
|
+
</dl>
|
561
|
+
</details>
|
562
|
+
|
563
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
564
|
+
<dl>
|
565
|
+
<dd>
|
566
|
+
|
354
567
|
#### 🔌 Usage
|
355
568
|
|
356
569
|
<dl>
|
@@ -360,7 +573,9 @@ Creates a new browser window in a session. Optionally, you can specify a url to
|
|
360
573
|
<dd>
|
361
574
|
|
362
575
|
```typescript
|
363
|
-
await client.windows.
|
576
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
577
|
+
condition: "Determine if the user appears to be signed in to the website",
|
578
|
+
});
|
364
579
|
```
|
365
580
|
|
366
581
|
</dd>
|
@@ -376,7 +591,1089 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
376
591
|
<dl>
|
377
592
|
<dd>
|
378
593
|
|
379
|
-
**sessionId:** `string` —
|
594
|
+
**sessionId:** `string` — The session id for the window.
|
595
|
+
|
596
|
+
</dd>
|
597
|
+
</dl>
|
598
|
+
|
599
|
+
<dl>
|
600
|
+
<dd>
|
601
|
+
|
602
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
603
|
+
|
604
|
+
</dd>
|
605
|
+
</dl>
|
606
|
+
|
607
|
+
<dl>
|
608
|
+
<dd>
|
609
|
+
|
610
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
611
|
+
|
612
|
+
</dd>
|
613
|
+
</dl>
|
614
|
+
|
615
|
+
<dl>
|
616
|
+
<dd>
|
617
|
+
|
618
|
+
**requestOptions:** `Windows.RequestOptions`
|
619
|
+
|
620
|
+
</dd>
|
621
|
+
</dl>
|
622
|
+
</dd>
|
623
|
+
</dl>
|
624
|
+
|
625
|
+
</dd>
|
626
|
+
</dl>
|
627
|
+
</details>
|
628
|
+
|
629
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
630
|
+
<dl>
|
631
|
+
<dd>
|
632
|
+
|
633
|
+
#### 🔌 Usage
|
634
|
+
|
635
|
+
<dl>
|
636
|
+
<dd>
|
637
|
+
|
638
|
+
<dl>
|
639
|
+
<dd>
|
640
|
+
|
641
|
+
```typescript
|
642
|
+
await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
643
|
+
prompt: "What is the main idea of this page?",
|
644
|
+
});
|
645
|
+
```
|
646
|
+
|
647
|
+
</dd>
|
648
|
+
</dl>
|
649
|
+
</dd>
|
650
|
+
</dl>
|
651
|
+
|
652
|
+
#### ⚙️ Parameters
|
653
|
+
|
654
|
+
<dl>
|
655
|
+
<dd>
|
656
|
+
|
657
|
+
<dl>
|
658
|
+
<dd>
|
659
|
+
|
660
|
+
**sessionId:** `string` — The session id for the window.
|
661
|
+
|
662
|
+
</dd>
|
663
|
+
</dl>
|
664
|
+
|
665
|
+
<dl>
|
666
|
+
<dd>
|
667
|
+
|
668
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
669
|
+
|
670
|
+
</dd>
|
671
|
+
</dl>
|
672
|
+
|
673
|
+
<dl>
|
674
|
+
<dd>
|
675
|
+
|
676
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
677
|
+
|
678
|
+
</dd>
|
679
|
+
</dl>
|
680
|
+
|
681
|
+
<dl>
|
682
|
+
<dd>
|
683
|
+
|
684
|
+
**requestOptions:** `Windows.RequestOptions`
|
685
|
+
|
686
|
+
</dd>
|
687
|
+
</dl>
|
688
|
+
</dd>
|
689
|
+
</dl>
|
690
|
+
|
691
|
+
</dd>
|
692
|
+
</dl>
|
693
|
+
</details>
|
694
|
+
|
695
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
696
|
+
<dl>
|
697
|
+
<dd>
|
698
|
+
|
699
|
+
#### 🔌 Usage
|
700
|
+
|
701
|
+
<dl>
|
702
|
+
<dd>
|
703
|
+
|
704
|
+
<dl>
|
705
|
+
<dd>
|
706
|
+
|
707
|
+
```typescript
|
708
|
+
await client.windows.asyncPaginatedExtraction(
|
709
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
710
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
711
|
+
{
|
712
|
+
prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
|
713
|
+
},
|
714
|
+
);
|
715
|
+
```
|
716
|
+
|
717
|
+
</dd>
|
718
|
+
</dl>
|
719
|
+
</dd>
|
720
|
+
</dl>
|
721
|
+
|
722
|
+
#### ⚙️ Parameters
|
723
|
+
|
724
|
+
<dl>
|
725
|
+
<dd>
|
726
|
+
|
727
|
+
<dl>
|
728
|
+
<dd>
|
729
|
+
|
730
|
+
**sessionId:** `string` — The session id for the window.
|
731
|
+
|
732
|
+
</dd>
|
733
|
+
</dl>
|
734
|
+
|
735
|
+
<dl>
|
736
|
+
<dd>
|
737
|
+
|
738
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
739
|
+
|
740
|
+
</dd>
|
741
|
+
</dl>
|
742
|
+
|
743
|
+
<dl>
|
744
|
+
<dd>
|
745
|
+
|
746
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
747
|
+
|
748
|
+
</dd>
|
749
|
+
</dl>
|
750
|
+
|
751
|
+
<dl>
|
752
|
+
<dd>
|
753
|
+
|
754
|
+
**requestOptions:** `Windows.RequestOptions`
|
755
|
+
|
756
|
+
</dd>
|
757
|
+
</dl>
|
758
|
+
</dd>
|
759
|
+
</dl>
|
760
|
+
|
761
|
+
</dd>
|
762
|
+
</dl>
|
763
|
+
</details>
|
764
|
+
|
765
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
766
|
+
<dl>
|
767
|
+
<dd>
|
768
|
+
|
769
|
+
#### 📝 Description
|
770
|
+
|
771
|
+
<dl>
|
772
|
+
<dd>
|
773
|
+
|
774
|
+
<dl>
|
775
|
+
<dd>
|
776
|
+
|
777
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
778
|
+
|
779
|
+
</dd>
|
780
|
+
</dl>
|
781
|
+
</dd>
|
782
|
+
</dl>
|
783
|
+
|
784
|
+
#### 🔌 Usage
|
785
|
+
|
786
|
+
<dl>
|
787
|
+
<dd>
|
788
|
+
|
789
|
+
<dl>
|
790
|
+
<dd>
|
791
|
+
|
792
|
+
```typescript
|
793
|
+
await client.windows.asyncPromptContent(
|
794
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
795
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
796
|
+
{
|
797
|
+
prompt: "What is the main idea of this page?",
|
798
|
+
},
|
799
|
+
);
|
800
|
+
```
|
801
|
+
|
802
|
+
</dd>
|
803
|
+
</dl>
|
804
|
+
</dd>
|
805
|
+
</dl>
|
806
|
+
|
807
|
+
#### ⚙️ Parameters
|
808
|
+
|
809
|
+
<dl>
|
810
|
+
<dd>
|
811
|
+
|
812
|
+
<dl>
|
813
|
+
<dd>
|
814
|
+
|
815
|
+
**sessionId:** `string` — The session id for the window.
|
816
|
+
|
817
|
+
</dd>
|
818
|
+
</dl>
|
819
|
+
|
820
|
+
<dl>
|
821
|
+
<dd>
|
822
|
+
|
823
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
824
|
+
|
825
|
+
</dd>
|
826
|
+
</dl>
|
827
|
+
|
828
|
+
<dl>
|
829
|
+
<dd>
|
830
|
+
|
831
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
832
|
+
|
833
|
+
</dd>
|
834
|
+
</dl>
|
835
|
+
|
836
|
+
<dl>
|
837
|
+
<dd>
|
838
|
+
|
839
|
+
**requestOptions:** `Windows.RequestOptions`
|
840
|
+
|
841
|
+
</dd>
|
842
|
+
</dl>
|
843
|
+
</dd>
|
844
|
+
</dl>
|
845
|
+
|
846
|
+
</dd>
|
847
|
+
</dl>
|
848
|
+
</details>
|
849
|
+
|
850
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
851
|
+
<dl>
|
852
|
+
<dd>
|
853
|
+
|
854
|
+
#### 📝 Description
|
855
|
+
|
856
|
+
<dl>
|
857
|
+
<dd>
|
858
|
+
|
859
|
+
<dl>
|
860
|
+
<dd>
|
861
|
+
|
862
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
863
|
+
|
864
|
+
</dd>
|
865
|
+
</dl>
|
866
|
+
</dd>
|
867
|
+
</dl>
|
868
|
+
|
869
|
+
#### 🔌 Usage
|
870
|
+
|
871
|
+
<dl>
|
872
|
+
<dd>
|
873
|
+
|
874
|
+
<dl>
|
875
|
+
<dd>
|
876
|
+
|
877
|
+
```typescript
|
878
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
879
|
+
```
|
880
|
+
|
881
|
+
</dd>
|
882
|
+
</dl>
|
883
|
+
</dd>
|
884
|
+
</dl>
|
885
|
+
|
886
|
+
#### ⚙️ Parameters
|
887
|
+
|
888
|
+
<dl>
|
889
|
+
<dd>
|
890
|
+
|
891
|
+
<dl>
|
892
|
+
<dd>
|
893
|
+
|
894
|
+
**sessionId:** `string` — The session id for the window.
|
895
|
+
|
896
|
+
</dd>
|
897
|
+
</dl>
|
898
|
+
|
899
|
+
<dl>
|
900
|
+
<dd>
|
901
|
+
|
902
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
903
|
+
|
904
|
+
</dd>
|
905
|
+
</dl>
|
906
|
+
|
907
|
+
<dl>
|
908
|
+
<dd>
|
909
|
+
|
910
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
911
|
+
|
912
|
+
</dd>
|
913
|
+
</dl>
|
914
|
+
|
915
|
+
<dl>
|
916
|
+
<dd>
|
917
|
+
|
918
|
+
**requestOptions:** `Windows.RequestOptions`
|
919
|
+
|
920
|
+
</dd>
|
921
|
+
</dl>
|
922
|
+
</dd>
|
923
|
+
</dl>
|
924
|
+
|
925
|
+
</dd>
|
926
|
+
</dl>
|
927
|
+
</details>
|
928
|
+
|
929
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
930
|
+
<dl>
|
931
|
+
<dd>
|
932
|
+
|
933
|
+
#### 📝 Description
|
934
|
+
|
935
|
+
<dl>
|
936
|
+
<dd>
|
937
|
+
|
938
|
+
<dl>
|
939
|
+
<dd>
|
940
|
+
|
941
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
942
|
+
|
943
|
+
</dd>
|
944
|
+
</dl>
|
945
|
+
</dd>
|
946
|
+
</dl>
|
947
|
+
|
948
|
+
#### 🔌 Usage
|
949
|
+
|
950
|
+
<dl>
|
951
|
+
<dd>
|
952
|
+
|
953
|
+
<dl>
|
954
|
+
<dd>
|
955
|
+
|
956
|
+
```typescript
|
957
|
+
await client.windows.asyncSummarizeContent(
|
958
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
959
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
960
|
+
);
|
961
|
+
```
|
962
|
+
|
963
|
+
</dd>
|
964
|
+
</dl>
|
965
|
+
</dd>
|
966
|
+
</dl>
|
967
|
+
|
968
|
+
#### ⚙️ Parameters
|
969
|
+
|
970
|
+
<dl>
|
971
|
+
<dd>
|
972
|
+
|
973
|
+
<dl>
|
974
|
+
<dd>
|
975
|
+
|
976
|
+
**sessionId:** `string` — The session id for the window.
|
977
|
+
|
978
|
+
</dd>
|
979
|
+
</dl>
|
980
|
+
|
981
|
+
<dl>
|
982
|
+
<dd>
|
983
|
+
|
984
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
985
|
+
|
986
|
+
</dd>
|
987
|
+
</dl>
|
988
|
+
|
989
|
+
<dl>
|
990
|
+
<dd>
|
991
|
+
|
992
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
993
|
+
|
994
|
+
</dd>
|
995
|
+
</dl>
|
996
|
+
|
997
|
+
<dl>
|
998
|
+
<dd>
|
999
|
+
|
1000
|
+
**requestOptions:** `Windows.RequestOptions`
|
1001
|
+
|
1002
|
+
</dd>
|
1003
|
+
</dl>
|
1004
|
+
</dd>
|
1005
|
+
</dl>
|
1006
|
+
|
1007
|
+
</dd>
|
1008
|
+
</dl>
|
1009
|
+
</details>
|
1010
|
+
|
1011
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1012
|
+
<dl>
|
1013
|
+
<dd>
|
1014
|
+
|
1015
|
+
#### 🔌 Usage
|
1016
|
+
|
1017
|
+
<dl>
|
1018
|
+
<dd>
|
1019
|
+
|
1020
|
+
<dl>
|
1021
|
+
<dd>
|
1022
|
+
|
1023
|
+
```typescript
|
1024
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1025
|
+
text: "Example text",
|
1026
|
+
});
|
1027
|
+
```
|
1028
|
+
|
1029
|
+
</dd>
|
1030
|
+
</dl>
|
1031
|
+
</dd>
|
1032
|
+
</dl>
|
1033
|
+
|
1034
|
+
#### ⚙️ Parameters
|
1035
|
+
|
1036
|
+
<dl>
|
1037
|
+
<dd>
|
1038
|
+
|
1039
|
+
<dl>
|
1040
|
+
<dd>
|
1041
|
+
|
1042
|
+
**sessionId:** `string` — The session id for the window.
|
1043
|
+
|
1044
|
+
</dd>
|
1045
|
+
</dl>
|
1046
|
+
|
1047
|
+
<dl>
|
1048
|
+
<dd>
|
1049
|
+
|
1050
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1051
|
+
|
1052
|
+
</dd>
|
1053
|
+
</dl>
|
1054
|
+
|
1055
|
+
<dl>
|
1056
|
+
<dd>
|
1057
|
+
|
1058
|
+
**request:** `Airtop.AsyncTypeRequest`
|
1059
|
+
|
1060
|
+
</dd>
|
1061
|
+
</dl>
|
1062
|
+
|
1063
|
+
<dl>
|
1064
|
+
<dd>
|
1065
|
+
|
1066
|
+
**requestOptions:** `Windows.RequestOptions`
|
1067
|
+
|
1068
|
+
</dd>
|
1069
|
+
</dl>
|
1070
|
+
</dd>
|
1071
|
+
</dl>
|
1072
|
+
|
1073
|
+
</dd>
|
1074
|
+
</dl>
|
1075
|
+
</details>
|
1076
|
+
|
1077
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
1078
|
+
<dl>
|
1079
|
+
<dd>
|
1080
|
+
|
1081
|
+
#### 📝 Description
|
1082
|
+
|
1083
|
+
<dl>
|
1084
|
+
<dd>
|
1085
|
+
|
1086
|
+
<dl>
|
1087
|
+
<dd>
|
1088
|
+
|
1089
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
1090
|
+
|
1091
|
+
</dd>
|
1092
|
+
</dl>
|
1093
|
+
</dd>
|
1094
|
+
</dl>
|
1095
|
+
|
1096
|
+
#### 🔌 Usage
|
1097
|
+
|
1098
|
+
<dl>
|
1099
|
+
<dd>
|
1100
|
+
|
1101
|
+
<dl>
|
1102
|
+
<dd>
|
1103
|
+
|
1104
|
+
```typescript
|
1105
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
1106
|
+
```
|
1107
|
+
|
1108
|
+
</dd>
|
1109
|
+
</dl>
|
1110
|
+
</dd>
|
1111
|
+
</dl>
|
1112
|
+
|
1113
|
+
#### ⚙️ Parameters
|
1114
|
+
|
1115
|
+
<dl>
|
1116
|
+
<dd>
|
1117
|
+
|
1118
|
+
<dl>
|
1119
|
+
<dd>
|
1120
|
+
|
1121
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1122
|
+
|
1123
|
+
</dd>
|
1124
|
+
</dl>
|
1125
|
+
|
1126
|
+
<dl>
|
1127
|
+
<dd>
|
1128
|
+
|
1129
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
1130
|
+
|
1131
|
+
</dd>
|
1132
|
+
</dl>
|
1133
|
+
|
1134
|
+
<dl>
|
1135
|
+
<dd>
|
1136
|
+
|
1137
|
+
**requestOptions:** `Windows.RequestOptions`
|
1138
|
+
|
1139
|
+
</dd>
|
1140
|
+
</dl>
|
1141
|
+
</dd>
|
1142
|
+
</dl>
|
1143
|
+
|
1144
|
+
</dd>
|
1145
|
+
</dl>
|
1146
|
+
</details>
|
1147
|
+
|
1148
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
|
1149
|
+
<dl>
|
1150
|
+
<dd>
|
1151
|
+
|
1152
|
+
#### 📝 Description
|
1153
|
+
|
1154
|
+
<dl>
|
1155
|
+
<dd>
|
1156
|
+
|
1157
|
+
<dl>
|
1158
|
+
<dd>
|
1159
|
+
|
1160
|
+
Get information about a browser window in a session, including the live view url.
|
1161
|
+
|
1162
|
+
</dd>
|
1163
|
+
</dl>
|
1164
|
+
</dd>
|
1165
|
+
</dl>
|
1166
|
+
|
1167
|
+
#### 🔌 Usage
|
1168
|
+
|
1169
|
+
<dl>
|
1170
|
+
<dd>
|
1171
|
+
|
1172
|
+
<dl>
|
1173
|
+
<dd>
|
1174
|
+
|
1175
|
+
```typescript
|
1176
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1177
|
+
screenResolution: "1280x720",
|
1178
|
+
});
|
1179
|
+
```
|
1180
|
+
|
1181
|
+
</dd>
|
1182
|
+
</dl>
|
1183
|
+
</dd>
|
1184
|
+
</dl>
|
1185
|
+
|
1186
|
+
#### ⚙️ Parameters
|
1187
|
+
|
1188
|
+
<dl>
|
1189
|
+
<dd>
|
1190
|
+
|
1191
|
+
<dl>
|
1192
|
+
<dd>
|
1193
|
+
|
1194
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1195
|
+
|
1196
|
+
</dd>
|
1197
|
+
</dl>
|
1198
|
+
|
1199
|
+
<dl>
|
1200
|
+
<dd>
|
1201
|
+
|
1202
|
+
**windowId:** `string` — ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
|
1203
|
+
|
1204
|
+
</dd>
|
1205
|
+
</dl>
|
1206
|
+
|
1207
|
+
<dl>
|
1208
|
+
<dd>
|
1209
|
+
|
1210
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
1211
|
+
|
1212
|
+
</dd>
|
1213
|
+
</dl>
|
1214
|
+
|
1215
|
+
<dl>
|
1216
|
+
<dd>
|
1217
|
+
|
1218
|
+
**requestOptions:** `Windows.RequestOptions`
|
1219
|
+
|
1220
|
+
</dd>
|
1221
|
+
</dl>
|
1222
|
+
</dd>
|
1223
|
+
</dl>
|
1224
|
+
|
1225
|
+
</dd>
|
1226
|
+
</dl>
|
1227
|
+
</details>
|
1228
|
+
|
1229
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
1230
|
+
<dl>
|
1231
|
+
<dd>
|
1232
|
+
|
1233
|
+
#### 📝 Description
|
1234
|
+
|
1235
|
+
<dl>
|
1236
|
+
<dd>
|
1237
|
+
|
1238
|
+
<dl>
|
1239
|
+
<dd>
|
1240
|
+
|
1241
|
+
Loads a specified url on a given window
|
1242
|
+
|
1243
|
+
</dd>
|
1244
|
+
</dl>
|
1245
|
+
</dd>
|
1246
|
+
</dl>
|
1247
|
+
|
1248
|
+
#### 🔌 Usage
|
1249
|
+
|
1250
|
+
<dl>
|
1251
|
+
<dd>
|
1252
|
+
|
1253
|
+
<dl>
|
1254
|
+
<dd>
|
1255
|
+
|
1256
|
+
```typescript
|
1257
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1258
|
+
url: "https://www.airtop.ai",
|
1259
|
+
});
|
1260
|
+
```
|
1261
|
+
|
1262
|
+
</dd>
|
1263
|
+
</dl>
|
1264
|
+
</dd>
|
1265
|
+
</dl>
|
1266
|
+
|
1267
|
+
#### ⚙️ Parameters
|
1268
|
+
|
1269
|
+
<dl>
|
1270
|
+
<dd>
|
1271
|
+
|
1272
|
+
<dl>
|
1273
|
+
<dd>
|
1274
|
+
|
1275
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1276
|
+
|
1277
|
+
</dd>
|
1278
|
+
</dl>
|
1279
|
+
|
1280
|
+
<dl>
|
1281
|
+
<dd>
|
1282
|
+
|
1283
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1284
|
+
|
1285
|
+
</dd>
|
1286
|
+
</dl>
|
1287
|
+
|
1288
|
+
<dl>
|
1289
|
+
<dd>
|
1290
|
+
|
1291
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
1292
|
+
|
1293
|
+
</dd>
|
1294
|
+
</dl>
|
1295
|
+
|
1296
|
+
<dl>
|
1297
|
+
<dd>
|
1298
|
+
|
1299
|
+
**requestOptions:** `Windows.RequestOptions`
|
1300
|
+
|
1301
|
+
</dd>
|
1302
|
+
</dl>
|
1303
|
+
</dd>
|
1304
|
+
</dl>
|
1305
|
+
|
1306
|
+
</dd>
|
1307
|
+
</dl>
|
1308
|
+
</details>
|
1309
|
+
|
1310
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
1311
|
+
<dl>
|
1312
|
+
<dd>
|
1313
|
+
|
1314
|
+
#### 📝 Description
|
1315
|
+
|
1316
|
+
<dl>
|
1317
|
+
<dd>
|
1318
|
+
|
1319
|
+
<dl>
|
1320
|
+
<dd>
|
1321
|
+
|
1322
|
+
Closes a browser window in a session
|
1323
|
+
|
1324
|
+
</dd>
|
1325
|
+
</dl>
|
1326
|
+
</dd>
|
1327
|
+
</dl>
|
1328
|
+
|
1329
|
+
#### 🔌 Usage
|
1330
|
+
|
1331
|
+
<dl>
|
1332
|
+
<dd>
|
1333
|
+
|
1334
|
+
<dl>
|
1335
|
+
<dd>
|
1336
|
+
|
1337
|
+
```typescript
|
1338
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
1339
|
+
```
|
1340
|
+
|
1341
|
+
</dd>
|
1342
|
+
</dl>
|
1343
|
+
</dd>
|
1344
|
+
</dl>
|
1345
|
+
|
1346
|
+
#### ⚙️ Parameters
|
1347
|
+
|
1348
|
+
<dl>
|
1349
|
+
<dd>
|
1350
|
+
|
1351
|
+
<dl>
|
1352
|
+
<dd>
|
1353
|
+
|
1354
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1355
|
+
|
1356
|
+
</dd>
|
1357
|
+
</dl>
|
1358
|
+
|
1359
|
+
<dl>
|
1360
|
+
<dd>
|
1361
|
+
|
1362
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1363
|
+
|
1364
|
+
</dd>
|
1365
|
+
</dl>
|
1366
|
+
|
1367
|
+
<dl>
|
1368
|
+
<dd>
|
1369
|
+
|
1370
|
+
**requestOptions:** `Windows.RequestOptions`
|
1371
|
+
|
1372
|
+
</dd>
|
1373
|
+
</dl>
|
1374
|
+
</dd>
|
1375
|
+
</dl>
|
1376
|
+
|
1377
|
+
</dd>
|
1378
|
+
</dl>
|
1379
|
+
</details>
|
1380
|
+
|
1381
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1382
|
+
<dl>
|
1383
|
+
<dd>
|
1384
|
+
|
1385
|
+
#### 📝 Description
|
1386
|
+
|
1387
|
+
<dl>
|
1388
|
+
<dd>
|
1389
|
+
|
1390
|
+
<dl>
|
1391
|
+
<dd>
|
1392
|
+
|
1393
|
+
Execute a click interaction in a specific browser window
|
1394
|
+
|
1395
|
+
</dd>
|
1396
|
+
</dl>
|
1397
|
+
</dd>
|
1398
|
+
</dl>
|
1399
|
+
|
1400
|
+
#### 🔌 Usage
|
1401
|
+
|
1402
|
+
<dl>
|
1403
|
+
<dd>
|
1404
|
+
|
1405
|
+
<dl>
|
1406
|
+
<dd>
|
1407
|
+
|
1408
|
+
```typescript
|
1409
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1410
|
+
elementDescription: "The login button",
|
1411
|
+
});
|
1412
|
+
```
|
1413
|
+
|
1414
|
+
</dd>
|
1415
|
+
</dl>
|
1416
|
+
</dd>
|
1417
|
+
</dl>
|
1418
|
+
|
1419
|
+
#### ⚙️ Parameters
|
1420
|
+
|
1421
|
+
<dl>
|
1422
|
+
<dd>
|
1423
|
+
|
1424
|
+
<dl>
|
1425
|
+
<dd>
|
1426
|
+
|
1427
|
+
**sessionId:** `string` — The session id for the window.
|
1428
|
+
|
1429
|
+
</dd>
|
1430
|
+
</dl>
|
1431
|
+
|
1432
|
+
<dl>
|
1433
|
+
<dd>
|
1434
|
+
|
1435
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1436
|
+
|
1437
|
+
</dd>
|
1438
|
+
</dl>
|
1439
|
+
|
1440
|
+
<dl>
|
1441
|
+
<dd>
|
1442
|
+
|
1443
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
1444
|
+
|
1445
|
+
</dd>
|
1446
|
+
</dl>
|
1447
|
+
|
1448
|
+
<dl>
|
1449
|
+
<dd>
|
1450
|
+
|
1451
|
+
**requestOptions:** `Windows.RequestOptions`
|
1452
|
+
|
1453
|
+
</dd>
|
1454
|
+
</dl>
|
1455
|
+
</dd>
|
1456
|
+
</dl>
|
1457
|
+
|
1458
|
+
</dd>
|
1459
|
+
</dl>
|
1460
|
+
</details>
|
1461
|
+
|
1462
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1463
|
+
<dl>
|
1464
|
+
<dd>
|
1465
|
+
|
1466
|
+
#### 📝 Description
|
1467
|
+
|
1468
|
+
<dl>
|
1469
|
+
<dd>
|
1470
|
+
|
1471
|
+
<dl>
|
1472
|
+
<dd>
|
1473
|
+
|
1474
|
+
Create a form-filler automation synchronously for the form loaded in the browser window
|
1475
|
+
|
1476
|
+
</dd>
|
1477
|
+
</dl>
|
1478
|
+
</dd>
|
1479
|
+
</dl>
|
1480
|
+
|
1481
|
+
#### 🔌 Usage
|
1482
|
+
|
1483
|
+
<dl>
|
1484
|
+
<dd>
|
1485
|
+
|
1486
|
+
<dl>
|
1487
|
+
<dd>
|
1488
|
+
|
1489
|
+
```typescript
|
1490
|
+
await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1491
|
+
```
|
1492
|
+
|
1493
|
+
</dd>
|
1494
|
+
</dl>
|
1495
|
+
</dd>
|
1496
|
+
</dl>
|
1497
|
+
|
1498
|
+
#### ⚙️ Parameters
|
1499
|
+
|
1500
|
+
<dl>
|
1501
|
+
<dd>
|
1502
|
+
|
1503
|
+
<dl>
|
1504
|
+
<dd>
|
1505
|
+
|
1506
|
+
**sessionId:** `string` — The session id for the window.
|
1507
|
+
|
1508
|
+
</dd>
|
1509
|
+
</dl>
|
1510
|
+
|
1511
|
+
<dl>
|
1512
|
+
<dd>
|
1513
|
+
|
1514
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1515
|
+
|
1516
|
+
</dd>
|
1517
|
+
</dl>
|
1518
|
+
|
1519
|
+
<dl>
|
1520
|
+
<dd>
|
1521
|
+
|
1522
|
+
**request:** `Airtop.CreateFormFillerRequest`
|
1523
|
+
|
1524
|
+
</dd>
|
1525
|
+
</dl>
|
1526
|
+
|
1527
|
+
<dl>
|
1528
|
+
<dd>
|
1529
|
+
|
1530
|
+
**requestOptions:** `Windows.RequestOptions`
|
1531
|
+
|
1532
|
+
</dd>
|
1533
|
+
</dl>
|
1534
|
+
</dd>
|
1535
|
+
</dl>
|
1536
|
+
|
1537
|
+
</dd>
|
1538
|
+
</dl>
|
1539
|
+
</details>
|
1540
|
+
|
1541
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fileInput</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1542
|
+
<dl>
|
1543
|
+
<dd>
|
1544
|
+
|
1545
|
+
#### 📝 Description
|
1546
|
+
|
1547
|
+
<dl>
|
1548
|
+
<dd>
|
1549
|
+
|
1550
|
+
<dl>
|
1551
|
+
<dd>
|
1552
|
+
|
1553
|
+
Execute a file input interaction in a specific browser window
|
1554
|
+
|
1555
|
+
</dd>
|
1556
|
+
</dl>
|
1557
|
+
</dd>
|
1558
|
+
</dl>
|
1559
|
+
|
1560
|
+
#### 🔌 Usage
|
1561
|
+
|
1562
|
+
<dl>
|
1563
|
+
<dd>
|
1564
|
+
|
1565
|
+
<dl>
|
1566
|
+
<dd>
|
1567
|
+
|
1568
|
+
```typescript
|
1569
|
+
await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1570
|
+
elementDescription: "The file input in the bottom left corner",
|
1571
|
+
});
|
1572
|
+
```
|
1573
|
+
|
1574
|
+
</dd>
|
1575
|
+
</dl>
|
1576
|
+
</dd>
|
1577
|
+
</dl>
|
1578
|
+
|
1579
|
+
#### ⚙️ Parameters
|
1580
|
+
|
1581
|
+
<dl>
|
1582
|
+
<dd>
|
1583
|
+
|
1584
|
+
<dl>
|
1585
|
+
<dd>
|
1586
|
+
|
1587
|
+
**sessionId:** `string` — The session id for the window.
|
1588
|
+
|
1589
|
+
</dd>
|
1590
|
+
</dl>
|
1591
|
+
|
1592
|
+
<dl>
|
1593
|
+
<dd>
|
1594
|
+
|
1595
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1596
|
+
|
1597
|
+
</dd>
|
1598
|
+
</dl>
|
1599
|
+
|
1600
|
+
<dl>
|
1601
|
+
<dd>
|
1602
|
+
|
1603
|
+
**request:** `Airtop.SessionFileInputHandlerRequestBody`
|
1604
|
+
|
1605
|
+
</dd>
|
1606
|
+
</dl>
|
1607
|
+
|
1608
|
+
<dl>
|
1609
|
+
<dd>
|
1610
|
+
|
1611
|
+
**requestOptions:** `Windows.RequestOptions`
|
1612
|
+
|
1613
|
+
</dd>
|
1614
|
+
</dl>
|
1615
|
+
</dd>
|
1616
|
+
</dl>
|
1617
|
+
|
1618
|
+
</dd>
|
1619
|
+
</dl>
|
1620
|
+
</details>
|
1621
|
+
|
1622
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1623
|
+
<dl>
|
1624
|
+
<dd>
|
1625
|
+
|
1626
|
+
#### 📝 Description
|
1627
|
+
|
1628
|
+
<dl>
|
1629
|
+
<dd>
|
1630
|
+
|
1631
|
+
<dl>
|
1632
|
+
<dd>
|
1633
|
+
|
1634
|
+
Fill a form of a browser window synchronously using a form-filler automation
|
1635
|
+
|
1636
|
+
</dd>
|
1637
|
+
</dl>
|
1638
|
+
</dd>
|
1639
|
+
</dl>
|
1640
|
+
|
1641
|
+
#### 🔌 Usage
|
1642
|
+
|
1643
|
+
<dl>
|
1644
|
+
<dd>
|
1645
|
+
|
1646
|
+
<dl>
|
1647
|
+
<dd>
|
1648
|
+
|
1649
|
+
```typescript
|
1650
|
+
await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1651
|
+
automationId: "automationId",
|
1652
|
+
});
|
1653
|
+
```
|
1654
|
+
|
1655
|
+
</dd>
|
1656
|
+
</dl>
|
1657
|
+
</dd>
|
1658
|
+
</dl>
|
1659
|
+
|
1660
|
+
#### ⚙️ Parameters
|
1661
|
+
|
1662
|
+
<dl>
|
1663
|
+
<dd>
|
1664
|
+
|
1665
|
+
<dl>
|
1666
|
+
<dd>
|
1667
|
+
|
1668
|
+
**sessionId:** `string` — The session id for the window.
|
1669
|
+
|
1670
|
+
</dd>
|
1671
|
+
</dl>
|
1672
|
+
|
1673
|
+
<dl>
|
1674
|
+
<dd>
|
1675
|
+
|
1676
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
380
1677
|
|
381
1678
|
</dd>
|
382
1679
|
</dl>
|
@@ -384,7 +1681,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
384
1681
|
<dl>
|
385
1682
|
<dd>
|
386
1683
|
|
387
|
-
**request:** `Airtop.
|
1684
|
+
**request:** `Airtop.FillFormRequest`
|
388
1685
|
|
389
1686
|
</dd>
|
390
1687
|
</dl>
|
@@ -403,7 +1700,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
403
1700
|
</dl>
|
404
1701
|
</details>
|
405
1702
|
|
406
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1703
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
407
1704
|
<dl>
|
408
1705
|
<dd>
|
409
1706
|
|
@@ -415,7 +1712,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
415
1712
|
<dl>
|
416
1713
|
<dd>
|
417
1714
|
|
418
|
-
|
1715
|
+
Execute a hover interaction in a specific browser window
|
419
1716
|
|
420
1717
|
</dd>
|
421
1718
|
</dl>
|
@@ -431,8 +1728,8 @@ Get information about a browser window in a session, including the live view url
|
|
431
1728
|
<dd>
|
432
1729
|
|
433
1730
|
```typescript
|
434
|
-
await client.windows.
|
435
|
-
|
1731
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1732
|
+
elementDescription: "The search box input in the top right corner",
|
436
1733
|
});
|
437
1734
|
```
|
438
1735
|
|
@@ -449,7 +1746,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
449
1746
|
<dl>
|
450
1747
|
<dd>
|
451
1748
|
|
452
|
-
**sessionId:** `string` —
|
1749
|
+
**sessionId:** `string` — The session id for the window.
|
453
1750
|
|
454
1751
|
</dd>
|
455
1752
|
</dl>
|
@@ -457,7 +1754,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
457
1754
|
<dl>
|
458
1755
|
<dd>
|
459
1756
|
|
460
|
-
**windowId:** `string` —
|
1757
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
461
1758
|
|
462
1759
|
</dd>
|
463
1760
|
</dl>
|
@@ -465,7 +1762,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
465
1762
|
<dl>
|
466
1763
|
<dd>
|
467
1764
|
|
468
|
-
**request:** `Airtop.
|
1765
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
469
1766
|
|
470
1767
|
</dd>
|
471
1768
|
</dl>
|
@@ -484,25 +1781,10 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
484
1781
|
</dl>
|
485
1782
|
</details>
|
486
1783
|
|
487
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
488
|
-
<dl>
|
489
|
-
<dd>
|
490
|
-
|
491
|
-
#### 📝 Description
|
492
|
-
|
493
|
-
<dl>
|
494
|
-
<dd>
|
495
|
-
|
1784
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
496
1785
|
<dl>
|
497
1786
|
<dd>
|
498
1787
|
|
499
|
-
Loads a specified url on a given window
|
500
|
-
|
501
|
-
</dd>
|
502
|
-
</dl>
|
503
|
-
</dd>
|
504
|
-
</dl>
|
505
|
-
|
506
1788
|
#### 🔌 Usage
|
507
1789
|
|
508
1790
|
<dl>
|
@@ -512,8 +1794,8 @@ Loads a specified url on a given window
|
|
512
1794
|
<dd>
|
513
1795
|
|
514
1796
|
```typescript
|
515
|
-
await client.windows.
|
516
|
-
|
1797
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1798
|
+
condition: "Determine if the user appears to be signed in to the website",
|
517
1799
|
});
|
518
1800
|
```
|
519
1801
|
|
@@ -530,7 +1812,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
530
1812
|
<dl>
|
531
1813
|
<dd>
|
532
1814
|
|
533
|
-
**sessionId:** `string` —
|
1815
|
+
**sessionId:** `string` — The session id for the window.
|
534
1816
|
|
535
1817
|
</dd>
|
536
1818
|
</dl>
|
@@ -538,7 +1820,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
538
1820
|
<dl>
|
539
1821
|
<dd>
|
540
1822
|
|
541
|
-
**windowId:** `string` — Airtop window
|
1823
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
542
1824
|
|
543
1825
|
</dd>
|
544
1826
|
</dl>
|
@@ -546,7 +1828,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
546
1828
|
<dl>
|
547
1829
|
<dd>
|
548
1830
|
|
549
|
-
**request:** `Airtop.
|
1831
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
550
1832
|
|
551
1833
|
</dd>
|
552
1834
|
</dl>
|
@@ -565,7 +1847,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
565
1847
|
</dl>
|
566
1848
|
</details>
|
567
1849
|
|
568
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1850
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">operatorPrompt</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncOperatorPromptResponseEnvelope</code></summary>
|
569
1851
|
<dl>
|
570
1852
|
<dd>
|
571
1853
|
|
@@ -577,7 +1859,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
577
1859
|
<dl>
|
578
1860
|
<dd>
|
579
1861
|
|
580
|
-
|
1862
|
+
Prompt OpenAI Operator
|
581
1863
|
|
582
1864
|
</dd>
|
583
1865
|
</dl>
|
@@ -593,7 +1875,9 @@ Closes a browser window in a session
|
|
593
1875
|
<dd>
|
594
1876
|
|
595
1877
|
```typescript
|
596
|
-
await client.windows.
|
1878
|
+
await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1879
|
+
prompt: "What is the latest news about OpenAI?",
|
1880
|
+
});
|
597
1881
|
```
|
598
1882
|
|
599
1883
|
</dd>
|
@@ -625,6 +1909,14 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
625
1909
|
<dl>
|
626
1910
|
<dd>
|
627
1911
|
|
1912
|
+
**request:** `Airtop.OperatorPromptV1Body`
|
1913
|
+
|
1914
|
+
</dd>
|
1915
|
+
</dl>
|
1916
|
+
|
1917
|
+
<dl>
|
1918
|
+
<dd>
|
1919
|
+
|
628
1920
|
**requestOptions:** `Windows.RequestOptions`
|
629
1921
|
|
630
1922
|
</dd>
|
@@ -636,7 +1928,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
636
1928
|
</dl>
|
637
1929
|
</details>
|
638
1930
|
|
639
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1931
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
640
1932
|
<dl>
|
641
1933
|
<dd>
|
642
1934
|
|
@@ -648,7 +1940,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
648
1940
|
<dl>
|
649
1941
|
<dd>
|
650
1942
|
|
651
|
-
|
1943
|
+
Submit a prompt that queries the content of a specific browser window. You may extract content from the page, or ask a question about the page and allow the AI to answer it (ex. Is the user logged in?).
|
652
1944
|
|
653
1945
|
</dd>
|
654
1946
|
</dl>
|
@@ -664,8 +1956,8 @@ Execute a click interaction in a specific browser window
|
|
664
1956
|
<dd>
|
665
1957
|
|
666
1958
|
```typescript
|
667
|
-
await client.windows.
|
668
|
-
|
1959
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1960
|
+
prompt: "What is the main idea of this page?",
|
669
1961
|
});
|
670
1962
|
```
|
671
1963
|
|
@@ -698,7 +1990,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
698
1990
|
<dl>
|
699
1991
|
<dd>
|
700
1992
|
|
701
|
-
**request:** `Airtop.
|
1993
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
702
1994
|
|
703
1995
|
</dd>
|
704
1996
|
</dl>
|
@@ -717,7 +2009,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
717
2009
|
</dl>
|
718
2010
|
</details>
|
719
2011
|
|
720
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2012
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
721
2013
|
<dl>
|
722
2014
|
<dd>
|
723
2015
|
|
@@ -729,7 +2021,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
729
2021
|
<dl>
|
730
2022
|
<dd>
|
731
2023
|
|
732
|
-
|
2024
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
733
2025
|
|
734
2026
|
</dd>
|
735
2027
|
</dl>
|
@@ -745,7 +2037,13 @@ Create a form-filler automation synchronously for the form loaded in the browser
|
|
745
2037
|
<dd>
|
746
2038
|
|
747
2039
|
```typescript
|
748
|
-
await client.windows.
|
2040
|
+
await client.windows.paginatedExtraction(
|
2041
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
2042
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
2043
|
+
{
|
2044
|
+
prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
|
2045
|
+
},
|
2046
|
+
);
|
749
2047
|
```
|
750
2048
|
|
751
2049
|
</dd>
|
@@ -777,7 +2075,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
777
2075
|
<dl>
|
778
2076
|
<dd>
|
779
2077
|
|
780
|
-
**request:** `Airtop.
|
2078
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
781
2079
|
|
782
2080
|
</dd>
|
783
2081
|
</dl>
|
@@ -796,7 +2094,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
796
2094
|
</dl>
|
797
2095
|
</details>
|
798
2096
|
|
799
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2097
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
800
2098
|
<dl>
|
801
2099
|
<dd>
|
802
2100
|
|
@@ -808,7 +2106,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
808
2106
|
<dl>
|
809
2107
|
<dd>
|
810
2108
|
|
811
|
-
|
2109
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
812
2110
|
|
813
2111
|
</dd>
|
814
2112
|
</dl>
|
@@ -824,8 +2122,8 @@ Fill a form of a browser window synchronously using a form-filler automation
|
|
824
2122
|
<dd>
|
825
2123
|
|
826
2124
|
```typescript
|
827
|
-
await client.windows.
|
828
|
-
|
2125
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2126
|
+
prompt: "What is the main idea of this page?",
|
829
2127
|
});
|
830
2128
|
```
|
831
2129
|
|
@@ -858,7 +2156,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
858
2156
|
<dl>
|
859
2157
|
<dd>
|
860
2158
|
|
861
|
-
**request:** `Airtop.
|
2159
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
862
2160
|
|
863
2161
|
</dd>
|
864
2162
|
</dl>
|
@@ -877,7 +2175,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
877
2175
|
</dl>
|
878
2176
|
</details>
|
879
2177
|
|
880
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2178
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
881
2179
|
<dl>
|
882
2180
|
<dd>
|
883
2181
|
|
@@ -889,7 +2187,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
889
2187
|
<dl>
|
890
2188
|
<dd>
|
891
2189
|
|
892
|
-
|
2190
|
+
Scrape a window and return the content as markdown
|
893
2191
|
|
894
2192
|
</dd>
|
895
2193
|
</dl>
|
@@ -905,9 +2203,7 @@ Execute a hover interaction in a specific browser window
|
|
905
2203
|
<dd>
|
906
2204
|
|
907
2205
|
```typescript
|
908
|
-
await client.windows.
|
909
|
-
elementDescription: "The search box input in the top right corner",
|
910
|
-
});
|
2206
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
911
2207
|
```
|
912
2208
|
|
913
2209
|
</dd>
|
@@ -931,7 +2227,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
931
2227
|
<dl>
|
932
2228
|
<dd>
|
933
2229
|
|
934
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
2230
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
935
2231
|
|
936
2232
|
</dd>
|
937
2233
|
</dl>
|
@@ -939,7 +2235,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
939
2235
|
<dl>
|
940
2236
|
<dd>
|
941
2237
|
|
942
|
-
**request:** `Airtop.
|
2238
|
+
**request:** `Airtop.ScrapeContentRequest`
|
943
2239
|
|
944
2240
|
</dd>
|
945
2241
|
</dl>
|
@@ -958,10 +2254,25 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
958
2254
|
</dl>
|
959
2255
|
</details>
|
960
2256
|
|
961
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2257
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2258
|
+
<dl>
|
2259
|
+
<dd>
|
2260
|
+
|
2261
|
+
#### 📝 Description
|
2262
|
+
|
962
2263
|
<dl>
|
963
2264
|
<dd>
|
964
2265
|
|
2266
|
+
<dl>
|
2267
|
+
<dd>
|
2268
|
+
|
2269
|
+
Take a screenshot of a browser window
|
2270
|
+
|
2271
|
+
</dd>
|
2272
|
+
</dl>
|
2273
|
+
</dd>
|
2274
|
+
</dl>
|
2275
|
+
|
965
2276
|
#### 🔌 Usage
|
966
2277
|
|
967
2278
|
<dl>
|
@@ -971,9 +2282,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
971
2282
|
<dd>
|
972
2283
|
|
973
2284
|
```typescript
|
974
|
-
await client.windows.
|
975
|
-
condition: "Determine if the user appears to be signed in to the website",
|
976
|
-
});
|
2285
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
977
2286
|
```
|
978
2287
|
|
979
2288
|
</dd>
|
@@ -1005,7 +2314,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1005
2314
|
<dl>
|
1006
2315
|
<dd>
|
1007
2316
|
|
1008
|
-
**request:** `Airtop.
|
2317
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
1009
2318
|
|
1010
2319
|
</dd>
|
1011
2320
|
</dl>
|
@@ -1024,7 +2333,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1024
2333
|
</dl>
|
1025
2334
|
</details>
|
1026
2335
|
|
1027
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2336
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1028
2337
|
<dl>
|
1029
2338
|
<dd>
|
1030
2339
|
|
@@ -1036,7 +2345,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1036
2345
|
<dl>
|
1037
2346
|
<dd>
|
1038
2347
|
|
1039
|
-
|
2348
|
+
Execute a scroll interaction in a specific browser window
|
1040
2349
|
|
1041
2350
|
</dd>
|
1042
2351
|
</dl>
|
@@ -1052,9 +2361,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
1052
2361
|
<dd>
|
1053
2362
|
|
1054
2363
|
```typescript
|
1055
|
-
await client.windows.
|
1056
|
-
prompt: "What is the main idea of this page?",
|
1057
|
-
});
|
2364
|
+
await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1058
2365
|
```
|
1059
2366
|
|
1060
2367
|
</dd>
|
@@ -1086,7 +2393,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1086
2393
|
<dl>
|
1087
2394
|
<dd>
|
1088
2395
|
|
1089
|
-
**request:** `Airtop.
|
2396
|
+
**request:** `Airtop.SessionScrollHandlerRequestBody`
|
1090
2397
|
|
1091
2398
|
</dd>
|
1092
2399
|
</dl>
|
@@ -1105,7 +2412,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1105
2412
|
</dl>
|
1106
2413
|
</details>
|
1107
2414
|
|
1108
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2415
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1109
2416
|
<dl>
|
1110
2417
|
<dd>
|
1111
2418
|
|
@@ -1117,7 +2424,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1117
2424
|
<dl>
|
1118
2425
|
<dd>
|
1119
2426
|
|
1120
|
-
|
2427
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
1121
2428
|
|
1122
2429
|
</dd>
|
1123
2430
|
</dl>
|
@@ -1133,13 +2440,7 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
1133
2440
|
<dd>
|
1134
2441
|
|
1135
2442
|
```typescript
|
1136
|
-
await client.windows.
|
1137
|
-
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1138
|
-
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
1139
|
-
{
|
1140
|
-
prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
|
1141
|
-
},
|
1142
|
-
);
|
2443
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1143
2444
|
```
|
1144
2445
|
|
1145
2446
|
</dd>
|
@@ -1163,7 +2464,7 @@ await client.windows.paginatedExtraction(
|
|
1163
2464
|
<dl>
|
1164
2465
|
<dd>
|
1165
2466
|
|
1166
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
2467
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
1167
2468
|
|
1168
2469
|
</dd>
|
1169
2470
|
</dl>
|
@@ -1171,7 +2472,7 @@ await client.windows.paginatedExtraction(
|
|
1171
2472
|
<dl>
|
1172
2473
|
<dd>
|
1173
2474
|
|
1174
|
-
**request:** `Airtop.
|
2475
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
1175
2476
|
|
1176
2477
|
</dd>
|
1177
2478
|
</dl>
|
@@ -1190,7 +2491,7 @@ await client.windows.paginatedExtraction(
|
|
1190
2491
|
</dl>
|
1191
2492
|
</details>
|
1192
2493
|
|
1193
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2494
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1194
2495
|
<dl>
|
1195
2496
|
<dd>
|
1196
2497
|
|
@@ -1202,7 +2503,7 @@ await client.windows.paginatedExtraction(
|
|
1202
2503
|
<dl>
|
1203
2504
|
<dd>
|
1204
2505
|
|
1205
|
-
|
2506
|
+
Execute a type interaction in a specific browser window
|
1206
2507
|
|
1207
2508
|
</dd>
|
1208
2509
|
</dl>
|
@@ -1218,8 +2519,8 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
1218
2519
|
<dd>
|
1219
2520
|
|
1220
2521
|
```typescript
|
1221
|
-
await client.windows.
|
1222
|
-
|
2522
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2523
|
+
text: "Example text",
|
1223
2524
|
});
|
1224
2525
|
```
|
1225
2526
|
|
@@ -1252,7 +2553,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1252
2553
|
<dl>
|
1253
2554
|
<dd>
|
1254
2555
|
|
1255
|
-
**request:** `Airtop.
|
2556
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
1256
2557
|
|
1257
2558
|
</dd>
|
1258
2559
|
</dl>
|
@@ -1271,7 +2572,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1271
2572
|
</dl>
|
1272
2573
|
</details>
|
1273
2574
|
|
1274
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2575
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">act</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1275
2576
|
<dl>
|
1276
2577
|
<dd>
|
1277
2578
|
|
@@ -1283,7 +2584,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1283
2584
|
<dl>
|
1284
2585
|
<dd>
|
1285
2586
|
|
1286
|
-
|
2587
|
+
Perform actions in a specific browser window based on a prompt
|
1287
2588
|
|
1288
2589
|
</dd>
|
1289
2590
|
</dl>
|
@@ -1299,7 +2600,10 @@ Scrape a window and return the content as markdown
|
|
1299
2600
|
<dd>
|
1300
2601
|
|
1301
2602
|
```typescript
|
1302
|
-
await client.windows.
|
2603
|
+
await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2604
|
+
jobId: "123",
|
2605
|
+
prompt: "Click the login button",
|
2606
|
+
});
|
1303
2607
|
```
|
1304
2608
|
|
1305
2609
|
</dd>
|
@@ -1323,7 +2627,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1323
2627
|
<dl>
|
1324
2628
|
<dd>
|
1325
2629
|
|
1326
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
2630
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1327
2631
|
|
1328
2632
|
</dd>
|
1329
2633
|
</dl>
|
@@ -1331,7 +2635,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1331
2635
|
<dl>
|
1332
2636
|
<dd>
|
1333
2637
|
|
1334
|
-
**request:** `Airtop.
|
2638
|
+
**request:** `Airtop.ActRequest`
|
1335
2639
|
|
1336
2640
|
</dd>
|
1337
2641
|
</dl>
|
@@ -1350,7 +2654,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1350
2654
|
</dl>
|
1351
2655
|
</details>
|
1352
2656
|
|
1353
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2657
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">extract</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1354
2658
|
<dl>
|
1355
2659
|
<dd>
|
1356
2660
|
|
@@ -1362,7 +2666,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1362
2666
|
<dl>
|
1363
2667
|
<dd>
|
1364
2668
|
|
1365
|
-
|
2669
|
+
Extract data from a specific browser window based on a prompt
|
1366
2670
|
|
1367
2671
|
</dd>
|
1368
2672
|
</dl>
|
@@ -1378,7 +2682,10 @@ Take a screenshot of a browser window
|
|
1378
2682
|
<dd>
|
1379
2683
|
|
1380
2684
|
```typescript
|
1381
|
-
await client.windows.
|
2685
|
+
await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2686
|
+
jobId: "123",
|
2687
|
+
prompt: "Extract all product prices from this page",
|
2688
|
+
});
|
1382
2689
|
```
|
1383
2690
|
|
1384
2691
|
</dd>
|
@@ -1410,7 +2717,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1410
2717
|
<dl>
|
1411
2718
|
<dd>
|
1412
2719
|
|
1413
|
-
**request:** `Airtop.
|
2720
|
+
**request:** `Airtop.ExtractRequest`
|
1414
2721
|
|
1415
2722
|
</dd>
|
1416
2723
|
</dl>
|
@@ -1429,7 +2736,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1429
2736
|
</dl>
|
1430
2737
|
</details>
|
1431
2738
|
|
1432
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2739
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findMany</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1433
2740
|
<dl>
|
1434
2741
|
<dd>
|
1435
2742
|
|
@@ -1441,7 +2748,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1441
2748
|
<dl>
|
1442
2749
|
<dd>
|
1443
2750
|
|
1444
|
-
|
2751
|
+
Find multiple elements in a browser window based on a prompt
|
1445
2752
|
|
1446
2753
|
</dd>
|
1447
2754
|
</dl>
|
@@ -1457,7 +2764,10 @@ Execute a scroll interaction in a specific browser window
|
|
1457
2764
|
<dd>
|
1458
2765
|
|
1459
2766
|
```typescript
|
1460
|
-
await client.windows.
|
2767
|
+
await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2768
|
+
jobId: "123",
|
2769
|
+
prompt: "Find all the news articles",
|
2770
|
+
});
|
1461
2771
|
```
|
1462
2772
|
|
1463
2773
|
</dd>
|
@@ -1489,7 +2799,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1489
2799
|
<dl>
|
1490
2800
|
<dd>
|
1491
2801
|
|
1492
|
-
**request:** `Airtop.
|
2802
|
+
**request:** `Airtop.FindManyRequest`
|
1493
2803
|
|
1494
2804
|
</dd>
|
1495
2805
|
</dl>
|
@@ -1508,7 +2818,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1508
2818
|
</dl>
|
1509
2819
|
</details>
|
1510
2820
|
|
1511
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2821
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findOne</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1512
2822
|
<dl>
|
1513
2823
|
<dd>
|
1514
2824
|
|
@@ -1520,7 +2830,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1520
2830
|
<dl>
|
1521
2831
|
<dd>
|
1522
2832
|
|
1523
|
-
|
2833
|
+
Find a specific element in a browser window based on a prompt
|
1524
2834
|
|
1525
2835
|
</dd>
|
1526
2836
|
</dl>
|
@@ -1536,7 +2846,10 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
1536
2846
|
<dd>
|
1537
2847
|
|
1538
2848
|
```typescript
|
1539
|
-
await client.windows.
|
2849
|
+
await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2850
|
+
jobId: "123",
|
2851
|
+
prompt: "Find the login button",
|
2852
|
+
});
|
1540
2853
|
```
|
1541
2854
|
|
1542
2855
|
</dd>
|
@@ -1560,7 +2873,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1560
2873
|
<dl>
|
1561
2874
|
<dd>
|
1562
2875
|
|
1563
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
2876
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1564
2877
|
|
1565
2878
|
</dd>
|
1566
2879
|
</dl>
|
@@ -1568,7 +2881,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1568
2881
|
<dl>
|
1569
2882
|
<dd>
|
1570
2883
|
|
1571
|
-
**request:** `Airtop.
|
2884
|
+
**request:** `Airtop.FindOneRequest`
|
1572
2885
|
|
1573
2886
|
</dd>
|
1574
2887
|
</dl>
|
@@ -1587,7 +2900,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1587
2900
|
</dl>
|
1588
2901
|
</details>
|
1589
2902
|
|
1590
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2903
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">llm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1591
2904
|
<dl>
|
1592
2905
|
<dd>
|
1593
2906
|
|
@@ -1599,7 +2912,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1599
2912
|
<dl>
|
1600
2913
|
<dd>
|
1601
2914
|
|
1602
|
-
|
2915
|
+
Send a prompt to an LLM with context from the browser window
|
1603
2916
|
|
1604
2917
|
</dd>
|
1605
2918
|
</dl>
|
@@ -1615,8 +2928,8 @@ Execute a type interaction in a specific browser window
|
|
1615
2928
|
<dd>
|
1616
2929
|
|
1617
2930
|
```typescript
|
1618
|
-
await client.windows.
|
1619
|
-
|
2931
|
+
await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2932
|
+
prompt: "Tell me about this webpage",
|
1620
2933
|
});
|
1621
2934
|
```
|
1622
2935
|
|
@@ -1649,7 +2962,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1649
2962
|
<dl>
|
1650
2963
|
<dd>
|
1651
2964
|
|
1652
|
-
**request:** `Airtop.
|
2965
|
+
**request:** `Airtop.LlmRequest`
|
1653
2966
|
|
1654
2967
|
</dd>
|
1655
2968
|
</dl>
|
@@ -2132,6 +3445,77 @@ await client.files.delete("id");
|
|
2132
3445
|
</dl>
|
2133
3446
|
</details>
|
2134
3447
|
|
3448
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">push</a>(id, { ...params }) -> void</code></summary>
|
3449
|
+
<dl>
|
3450
|
+
<dd>
|
3451
|
+
|
3452
|
+
#### 📝 Description
|
3453
|
+
|
3454
|
+
<dl>
|
3455
|
+
<dd>
|
3456
|
+
|
3457
|
+
<dl>
|
3458
|
+
<dd>
|
3459
|
+
|
3460
|
+
Push a file to one or more sessions, making it available for the sessions to use
|
3461
|
+
|
3462
|
+
</dd>
|
3463
|
+
</dl>
|
3464
|
+
</dd>
|
3465
|
+
</dl>
|
3466
|
+
|
3467
|
+
#### 🔌 Usage
|
3468
|
+
|
3469
|
+
<dl>
|
3470
|
+
<dd>
|
3471
|
+
|
3472
|
+
<dl>
|
3473
|
+
<dd>
|
3474
|
+
|
3475
|
+
```typescript
|
3476
|
+
await client.files.push("id");
|
3477
|
+
```
|
3478
|
+
|
3479
|
+
</dd>
|
3480
|
+
</dl>
|
3481
|
+
</dd>
|
3482
|
+
</dl>
|
3483
|
+
|
3484
|
+
#### ⚙️ Parameters
|
3485
|
+
|
3486
|
+
<dl>
|
3487
|
+
<dd>
|
3488
|
+
|
3489
|
+
<dl>
|
3490
|
+
<dd>
|
3491
|
+
|
3492
|
+
**id:** `string` — ID of the file
|
3493
|
+
|
3494
|
+
</dd>
|
3495
|
+
</dl>
|
3496
|
+
|
3497
|
+
<dl>
|
3498
|
+
<dd>
|
3499
|
+
|
3500
|
+
**request:** `Airtop.PushFileBodyV1`
|
3501
|
+
|
3502
|
+
</dd>
|
3503
|
+
</dl>
|
3504
|
+
|
3505
|
+
<dl>
|
3506
|
+
<dd>
|
3507
|
+
|
3508
|
+
**requestOptions:** `Files.RequestOptions`
|
3509
|
+
|
3510
|
+
</dd>
|
3511
|
+
</dl>
|
3512
|
+
</dd>
|
3513
|
+
</dl>
|
3514
|
+
|
3515
|
+
</dd>
|
3516
|
+
</dl>
|
3517
|
+
</details>
|
3518
|
+
|
2135
3519
|
## Profiles
|
2136
3520
|
|
2137
3521
|
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|