@airtop/sdk 0.1.40-beta0 → 0.1.41

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.
Files changed (201) hide show
  1. package/README.md +10 -9
  2. package/api/resources/automations/client/Client.js +4 -4
  3. package/api/resources/files/client/Client.d.ts +11 -0
  4. package/api/resources/files/client/Client.js +52 -4
  5. package/api/resources/files/client/requests/PushFileBodyV1.d.ts +11 -0
  6. package/api/resources/files/client/requests/index.d.ts +1 -0
  7. package/api/resources/profiles/client/Client.js +1 -1
  8. package/api/resources/requests/client/Client.js +1 -1
  9. package/api/resources/sessions/client/Client.js +6 -6
  10. package/api/resources/windows/client/Client.d.ts +14 -200
  11. package/api/resources/windows/client/Client.js +215 -1001
  12. package/api/resources/windows/client/requests/{AsyncClickRequest.d.ts → SessionFileInputHandlerRequestBody.d.ts} +8 -6
  13. package/api/resources/windows/client/requests/index.d.ts +1 -15
  14. package/api/types/FileEventMessage.d.ts +1 -0
  15. package/api/types/index.d.ts +0 -1
  16. package/api/types/index.js +0 -1
  17. package/dist/api/resources/automations/client/Client.js +4 -4
  18. package/dist/api/resources/files/client/Client.d.ts +11 -0
  19. package/dist/api/resources/files/client/Client.js +52 -4
  20. package/dist/api/resources/files/client/requests/PushFileBodyV1.d.ts +11 -0
  21. package/dist/api/resources/files/client/requests/index.d.ts +1 -0
  22. package/dist/api/resources/profiles/client/Client.js +1 -1
  23. package/dist/api/resources/requests/client/Client.js +1 -1
  24. package/dist/api/resources/sessions/client/Client.js +6 -6
  25. package/dist/api/resources/windows/client/Client.d.ts +14 -200
  26. package/dist/api/resources/windows/client/Client.js +215 -1001
  27. package/dist/api/resources/windows/client/requests/{AsyncClickRequest.d.ts → SessionFileInputHandlerRequestBody.d.ts} +8 -6
  28. package/dist/api/resources/windows/client/requests/index.d.ts +1 -15
  29. package/dist/api/types/FileEventMessage.d.ts +1 -0
  30. package/dist/api/types/index.d.ts +0 -1
  31. package/dist/api/types/index.js +0 -1
  32. package/dist/serialization/resources/files/client/requests/PushFileBodyV1.d.ts +12 -0
  33. package/{serialization/types/AsyncOperatorPromptResponseEnvelope.js → dist/serialization/resources/files/client/requests/PushFileBodyV1.js} +4 -7
  34. package/dist/serialization/resources/files/client/requests/index.d.ts +1 -0
  35. package/dist/serialization/resources/files/client/requests/index.js +3 -1
  36. package/dist/serialization/resources/windows/client/requests/{AsyncHoverRequest.d.ts → SessionFileInputHandlerRequestBody.d.ts} +5 -4
  37. package/{serialization/resources/windows/client/requests/AsyncHoverRequest.js → dist/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js} +5 -4
  38. package/dist/serialization/resources/windows/client/requests/index.d.ts +1 -15
  39. package/dist/serialization/resources/windows/client/requests/index.js +3 -31
  40. package/dist/serialization/types/FileEventMessage.d.ts +1 -0
  41. package/dist/serialization/types/FileEventMessage.js +1 -0
  42. package/dist/serialization/types/index.d.ts +0 -1
  43. package/dist/serialization/types/index.js +0 -1
  44. package/dist/utils/index.d.ts +1 -0
  45. package/dist/utils/index.js +1 -0
  46. package/dist/utils/upload.d.ts +13 -0
  47. package/dist/utils/upload.js +55 -0
  48. package/dist/version.d.ts +1 -1
  49. package/dist/version.js +1 -1
  50. package/dist/wrapper/AirtopClient.js +1 -1
  51. package/dist/wrapper/AirtopFiles.js +3 -3
  52. package/dist/wrapper/AirtopSessions.d.ts +24 -0
  53. package/dist/wrapper/AirtopSessions.js +103 -0
  54. package/dist/wrapper/AirtopWindows.d.ts +25 -1
  55. package/dist/wrapper/AirtopWindows.js +23 -1
  56. package/package.json +1 -1
  57. package/reference.md +187 -1186
  58. package/serialization/resources/files/client/requests/PushFileBodyV1.d.ts +12 -0
  59. package/{dist/serialization/types/AsyncOperatorPromptResponseEnvelope.js → serialization/resources/files/client/requests/PushFileBodyV1.js} +4 -7
  60. package/serialization/resources/files/client/requests/index.d.ts +1 -0
  61. package/serialization/resources/files/client/requests/index.js +3 -1
  62. package/serialization/resources/windows/client/requests/{AsyncHoverRequest.d.ts → SessionFileInputHandlerRequestBody.d.ts} +5 -4
  63. package/{dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js → serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js} +5 -4
  64. package/serialization/resources/windows/client/requests/index.d.ts +1 -15
  65. package/serialization/resources/windows/client/requests/index.js +3 -31
  66. package/serialization/types/FileEventMessage.d.ts +1 -0
  67. package/serialization/types/FileEventMessage.js +1 -0
  68. package/serialization/types/index.d.ts +0 -1
  69. package/serialization/types/index.js +0 -1
  70. package/utils/index.d.ts +1 -0
  71. package/utils/index.js +1 -0
  72. package/utils/upload.d.ts +13 -0
  73. package/utils/upload.js +55 -0
  74. package/version.d.ts +1 -1
  75. package/version.js +1 -1
  76. package/wrapper/AirtopClient.js +1 -1
  77. package/wrapper/AirtopFiles.js +3 -3
  78. package/wrapper/AirtopSessions.d.ts +24 -0
  79. package/wrapper/AirtopSessions.js +103 -0
  80. package/wrapper/AirtopWindows.d.ts +25 -1
  81. package/wrapper/AirtopWindows.js +23 -1
  82. package/api/resources/windows/client/requests/ActRequest.d.ts +0 -30
  83. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  84. package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  85. package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  86. package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
  87. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  88. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
  89. package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  90. package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
  91. package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
  92. package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  93. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
  94. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  95. package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  96. package/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  97. package/api/resources/windows/client/requests/ExtractRequest.d.ts +0 -30
  98. package/api/resources/windows/client/requests/ExtractRequest.js +0 -5
  99. package/api/resources/windows/client/requests/FindManyRequest.d.ts +0 -30
  100. package/api/resources/windows/client/requests/FindManyRequest.js +0 -5
  101. package/api/resources/windows/client/requests/FindOneRequest.d.ts +0 -30
  102. package/api/resources/windows/client/requests/FindOneRequest.js +0 -5
  103. package/api/resources/windows/client/requests/LlmRequest.d.ts +0 -25
  104. package/api/resources/windows/client/requests/LlmRequest.js +0 -5
  105. package/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -25
  106. package/api/resources/windows/client/requests/OperatorPromptV1Body.js +0 -5
  107. package/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -9
  108. package/api/types/AsyncOperatorPromptResponseEnvelope.js +0 -5
  109. package/dist/api/resources/windows/client/requests/ActRequest.d.ts +0 -30
  110. package/dist/api/resources/windows/client/requests/ActRequest.js +0 -5
  111. package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
  112. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  113. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
  114. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  115. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
  116. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  117. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
  118. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  119. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
  120. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  121. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
  122. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
  123. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  124. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
  125. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  126. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  127. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  128. package/dist/api/resources/windows/client/requests/ExtractRequest.d.ts +0 -30
  129. package/dist/api/resources/windows/client/requests/ExtractRequest.js +0 -5
  130. package/dist/api/resources/windows/client/requests/FindManyRequest.d.ts +0 -30
  131. package/dist/api/resources/windows/client/requests/FindManyRequest.js +0 -5
  132. package/dist/api/resources/windows/client/requests/FindOneRequest.d.ts +0 -30
  133. package/dist/api/resources/windows/client/requests/FindOneRequest.js +0 -5
  134. package/dist/api/resources/windows/client/requests/LlmRequest.d.ts +0 -25
  135. package/dist/api/resources/windows/client/requests/LlmRequest.js +0 -5
  136. package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -25
  137. package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.js +0 -5
  138. package/dist/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -9
  139. package/dist/api/types/AsyncOperatorPromptResponseEnvelope.js +0 -5
  140. package/dist/serialization/resources/windows/client/requests/ActRequest.d.ts +0 -19
  141. package/dist/serialization/resources/windows/client/requests/ActRequest.js +0 -50
  142. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
  143. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -51
  144. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -19
  145. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -50
  146. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
  147. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -51
  148. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  149. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -50
  150. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  151. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -51
  152. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
  153. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -49
  154. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  155. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -50
  156. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  157. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -55
  158. package/dist/serialization/resources/windows/client/requests/ExtractRequest.d.ts +0 -19
  159. package/dist/serialization/resources/windows/client/requests/ExtractRequest.js +0 -50
  160. package/dist/serialization/resources/windows/client/requests/FindManyRequest.d.ts +0 -19
  161. package/dist/serialization/resources/windows/client/requests/FindManyRequest.js +0 -50
  162. package/dist/serialization/resources/windows/client/requests/FindOneRequest.d.ts +0 -19
  163. package/dist/serialization/resources/windows/client/requests/FindOneRequest.js +0 -50
  164. package/dist/serialization/resources/windows/client/requests/LlmRequest.d.ts +0 -17
  165. package/dist/serialization/resources/windows/client/requests/LlmRequest.js +0 -48
  166. package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -17
  167. package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +0 -48
  168. package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -15
  169. package/serialization/resources/windows/client/requests/ActRequest.d.ts +0 -19
  170. package/serialization/resources/windows/client/requests/ActRequest.js +0 -50
  171. package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
  172. package/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -51
  173. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -19
  174. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -50
  175. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
  176. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -51
  177. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  178. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -50
  179. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  180. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -51
  181. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
  182. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -49
  183. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  184. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -50
  185. package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  186. package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -55
  187. package/serialization/resources/windows/client/requests/ExtractRequest.d.ts +0 -19
  188. package/serialization/resources/windows/client/requests/ExtractRequest.js +0 -50
  189. package/serialization/resources/windows/client/requests/FindManyRequest.d.ts +0 -19
  190. package/serialization/resources/windows/client/requests/FindManyRequest.js +0 -50
  191. package/serialization/resources/windows/client/requests/FindOneRequest.d.ts +0 -19
  192. package/serialization/resources/windows/client/requests/FindOneRequest.js +0 -50
  193. package/serialization/resources/windows/client/requests/LlmRequest.d.ts +0 -17
  194. package/serialization/resources/windows/client/requests/LlmRequest.js +0 -48
  195. package/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -17
  196. package/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +0 -48
  197. package/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -15
  198. /package/api/resources/{windows/client/requests/ActRequest.js → files/client/requests/PushFileBodyV1.js} +0 -0
  199. /package/api/resources/windows/client/requests/{AsyncClickRequest.js → SessionFileInputHandlerRequestBody.js} +0 -0
  200. /package/{api/resources/windows/client/requests/AsyncHoverRequest.js → dist/api/resources/files/client/requests/PushFileBodyV1.js} +0 -0
  201. /package/{api/resources/windows/client/requests/AsyncMonitorRequest.js → dist/api/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js} +0 -0
package/reference.md CHANGED
@@ -2,87 +2,6 @@
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
-
86
5
  <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
87
6
  <dl>
88
7
  <dd>
@@ -413,76 +332,25 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
413
332
  </dl>
414
333
  </details>
415
334
 
416
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
417
- <dl>
418
- <dd>
419
-
420
- #### 🔌 Usage
421
-
422
- <dl>
423
- <dd>
424
-
425
- <dl>
426
- <dd>
427
-
428
- ```typescript
429
- await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
430
- elementDescription: "The search box input in the top right corner",
431
- });
432
- ```
433
-
434
- </dd>
435
- </dl>
436
- </dd>
437
- </dl>
438
-
439
- #### ⚙️ Parameters
440
-
441
- <dl>
442
- <dd>
443
-
444
- <dl>
445
- <dd>
446
-
447
- **sessionId:** `string` — The session id for the window.
448
-
449
- </dd>
450
- </dl>
451
-
335
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
452
336
  <dl>
453
337
  <dd>
454
338
 
455
- **windowId:** `string` — The Airtop window id of the browser window.
456
-
457
- </dd>
458
- </dl>
339
+ #### 📝 Description
459
340
 
460
341
  <dl>
461
342
  <dd>
462
343
 
463
- **request:** `Airtop.AsyncHoverRequest`
464
-
465
- </dd>
466
- </dl>
467
-
468
344
  <dl>
469
345
  <dd>
470
346
 
471
- **requestOptions:** `Windows.RequestOptions`
347
+ Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
472
348
 
473
349
  </dd>
474
350
  </dl>
475
351
  </dd>
476
352
  </dl>
477
353
 
478
- </dd>
479
- </dl>
480
- </details>
481
-
482
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
483
- <dl>
484
- <dd>
485
-
486
354
  #### 🔌 Usage
487
355
 
488
356
  <dl>
@@ -492,9 +360,7 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
492
360
  <dd>
493
361
 
494
362
  ```typescript
495
- await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
496
- condition: "Determine if the user appears to be signed in to the website",
497
- });
363
+ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
498
364
  ```
499
365
 
500
366
  </dd>
@@ -510,15 +376,7 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
510
376
  <dl>
511
377
  <dd>
512
378
 
513
- **sessionId:** `string` — The session id for the window.
514
-
515
- </dd>
516
- </dl>
517
-
518
- <dl>
519
- <dd>
520
-
521
- **windowId:** `string` — The Airtop window id of the browser window.
379
+ **sessionId:** `string` — ID of the session that owns the window.
522
380
 
523
381
  </dd>
524
382
  </dl>
@@ -526,7 +384,7 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
526
384
  <dl>
527
385
  <dd>
528
386
 
529
- **request:** `Airtop.AsyncMonitorRequest`
387
+ **request:** `Airtop.CreateWindowInputV1Body`
530
388
 
531
389
  </dd>
532
390
  </dl>
@@ -545,76 +403,25 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
545
403
  </dl>
546
404
  </details>
547
405
 
548
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
549
- <dl>
550
- <dd>
551
-
552
- #### 🔌 Usage
553
-
554
- <dl>
555
- <dd>
556
-
557
- <dl>
558
- <dd>
559
-
560
- ```typescript
561
- await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
562
- prompt: "What is the main idea of this page?",
563
- });
564
- ```
565
-
566
- </dd>
567
- </dl>
568
- </dd>
569
- </dl>
570
-
571
- #### ⚙️ Parameters
572
-
573
- <dl>
574
- <dd>
575
-
576
- <dl>
577
- <dd>
578
-
579
- **sessionId:** `string` — The session id for the window.
580
-
581
- </dd>
582
- </dl>
583
-
406
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
584
407
  <dl>
585
408
  <dd>
586
409
 
587
- **windowId:** `string` — The Airtop window id of the browser window.
588
-
589
- </dd>
590
- </dl>
410
+ #### 📝 Description
591
411
 
592
412
  <dl>
593
413
  <dd>
594
414
 
595
- **request:** `Airtop.AsyncPageQueryRequest`
596
-
597
- </dd>
598
- </dl>
599
-
600
415
  <dl>
601
416
  <dd>
602
417
 
603
- **requestOptions:** `Windows.RequestOptions`
418
+ Get information about a browser window in a session, including the live view url.
604
419
 
605
420
  </dd>
606
421
  </dl>
607
422
  </dd>
608
423
  </dl>
609
424
 
610
- </dd>
611
- </dl>
612
- </details>
613
-
614
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
615
- <dl>
616
- <dd>
617
-
618
425
  #### 🔌 Usage
619
426
 
620
427
  <dl>
@@ -624,869 +431,8 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
624
431
  <dd>
625
432
 
626
433
  ```typescript
627
- await client.windows.asyncPaginatedExtraction(
628
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
629
- "0334da2a-91b0-42c5-6156-76a5eba87430",
630
- {
631
- 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.",
632
- },
633
- );
634
- ```
635
-
636
- </dd>
637
- </dl>
638
- </dd>
639
- </dl>
640
-
641
- #### ⚙️ Parameters
642
-
643
- <dl>
644
- <dd>
645
-
646
- <dl>
647
- <dd>
648
-
649
- **sessionId:** `string` — The session id for the window.
650
-
651
- </dd>
652
- </dl>
653
-
654
- <dl>
655
- <dd>
656
-
657
- **windowId:** `string` — The Airtop window id of the browser window.
658
-
659
- </dd>
660
- </dl>
661
-
662
- <dl>
663
- <dd>
664
-
665
- **request:** `Airtop.AsyncPaginatedExtractionRequest`
666
-
667
- </dd>
668
- </dl>
669
-
670
- <dl>
671
- <dd>
672
-
673
- **requestOptions:** `Windows.RequestOptions`
674
-
675
- </dd>
676
- </dl>
677
- </dd>
678
- </dl>
679
-
680
- </dd>
681
- </dl>
682
- </details>
683
-
684
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
685
- <dl>
686
- <dd>
687
-
688
- #### 📝 Description
689
-
690
- <dl>
691
- <dd>
692
-
693
- <dl>
694
- <dd>
695
-
696
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
697
-
698
- </dd>
699
- </dl>
700
- </dd>
701
- </dl>
702
-
703
- #### 🔌 Usage
704
-
705
- <dl>
706
- <dd>
707
-
708
- <dl>
709
- <dd>
710
-
711
- ```typescript
712
- await client.windows.asyncPromptContent(
713
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
714
- "0334da2a-91b0-42c5-6156-76a5eba87430",
715
- {
716
- prompt: "What is the main idea of this page?",
717
- },
718
- );
719
- ```
720
-
721
- </dd>
722
- </dl>
723
- </dd>
724
- </dl>
725
-
726
- #### ⚙️ Parameters
727
-
728
- <dl>
729
- <dd>
730
-
731
- <dl>
732
- <dd>
733
-
734
- **sessionId:** `string` — The session id for the window.
735
-
736
- </dd>
737
- </dl>
738
-
739
- <dl>
740
- <dd>
741
-
742
- **windowId:** `string` — The Airtop window id of the browser window.
743
-
744
- </dd>
745
- </dl>
746
-
747
- <dl>
748
- <dd>
749
-
750
- **request:** `Airtop.AsyncPromptContentRequest`
751
-
752
- </dd>
753
- </dl>
754
-
755
- <dl>
756
- <dd>
757
-
758
- **requestOptions:** `Windows.RequestOptions`
759
-
760
- </dd>
761
- </dl>
762
- </dd>
763
- </dl>
764
-
765
- </dd>
766
- </dl>
767
- </details>
768
-
769
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
770
- <dl>
771
- <dd>
772
-
773
- #### 📝 Description
774
-
775
- <dl>
776
- <dd>
777
-
778
- <dl>
779
- <dd>
780
-
781
- Take a screenshot of the current viewport of a browser window asynchronously
782
-
783
- </dd>
784
- </dl>
785
- </dd>
786
- </dl>
787
-
788
- #### 🔌 Usage
789
-
790
- <dl>
791
- <dd>
792
-
793
- <dl>
794
- <dd>
795
-
796
- ```typescript
797
- await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
798
- ```
799
-
800
- </dd>
801
- </dl>
802
- </dd>
803
- </dl>
804
-
805
- #### ⚙️ Parameters
806
-
807
- <dl>
808
- <dd>
809
-
810
- <dl>
811
- <dd>
812
-
813
- **sessionId:** `string` — The session id for the window.
814
-
815
- </dd>
816
- </dl>
817
-
818
- <dl>
819
- <dd>
820
-
821
- **windowId:** `string` — The Airtop window id of the browser window.
822
-
823
- </dd>
824
- </dl>
825
-
826
- <dl>
827
- <dd>
828
-
829
- **request:** `Airtop.AsyncScreenshotRequest`
830
-
831
- </dd>
832
- </dl>
833
-
834
- <dl>
835
- <dd>
836
-
837
- **requestOptions:** `Windows.RequestOptions`
838
-
839
- </dd>
840
- </dl>
841
- </dd>
842
- </dl>
843
-
844
- </dd>
845
- </dl>
846
- </details>
847
-
848
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
849
- <dl>
850
- <dd>
851
-
852
- #### 📝 Description
853
-
854
- <dl>
855
- <dd>
856
-
857
- <dl>
858
- <dd>
859
-
860
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
861
-
862
- </dd>
863
- </dl>
864
- </dd>
865
- </dl>
866
-
867
- #### 🔌 Usage
868
-
869
- <dl>
870
- <dd>
871
-
872
- <dl>
873
- <dd>
874
-
875
- ```typescript
876
- await client.windows.asyncSummarizeContent(
877
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
878
- "0334da2a-91b0-42c5-6156-76a5eba87430",
879
- );
880
- ```
881
-
882
- </dd>
883
- </dl>
884
- </dd>
885
- </dl>
886
-
887
- #### ⚙️ Parameters
888
-
889
- <dl>
890
- <dd>
891
-
892
- <dl>
893
- <dd>
894
-
895
- **sessionId:** `string` — The session id for the window.
896
-
897
- </dd>
898
- </dl>
899
-
900
- <dl>
901
- <dd>
902
-
903
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
904
-
905
- </dd>
906
- </dl>
907
-
908
- <dl>
909
- <dd>
910
-
911
- **request:** `Airtop.AsyncSummarizeContentRequest`
912
-
913
- </dd>
914
- </dl>
915
-
916
- <dl>
917
- <dd>
918
-
919
- **requestOptions:** `Windows.RequestOptions`
920
-
921
- </dd>
922
- </dl>
923
- </dd>
924
- </dl>
925
-
926
- </dd>
927
- </dl>
928
- </details>
929
-
930
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
931
- <dl>
932
- <dd>
933
-
934
- #### 🔌 Usage
935
-
936
- <dl>
937
- <dd>
938
-
939
- <dl>
940
- <dd>
941
-
942
- ```typescript
943
- await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
944
- text: "Example text",
945
- });
946
- ```
947
-
948
- </dd>
949
- </dl>
950
- </dd>
951
- </dl>
952
-
953
- #### ⚙️ Parameters
954
-
955
- <dl>
956
- <dd>
957
-
958
- <dl>
959
- <dd>
960
-
961
- **sessionId:** `string` — The session id for the window.
962
-
963
- </dd>
964
- </dl>
965
-
966
- <dl>
967
- <dd>
968
-
969
- **windowId:** `string` — The Airtop window id of the browser window.
970
-
971
- </dd>
972
- </dl>
973
-
974
- <dl>
975
- <dd>
976
-
977
- **request:** `Airtop.AsyncTypeRequest`
978
-
979
- </dd>
980
- </dl>
981
-
982
- <dl>
983
- <dd>
984
-
985
- **requestOptions:** `Windows.RequestOptions`
986
-
987
- </dd>
988
- </dl>
989
- </dd>
990
- </dl>
991
-
992
- </dd>
993
- </dl>
994
- </details>
995
-
996
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
997
- <dl>
998
- <dd>
999
-
1000
- #### 📝 Description
1001
-
1002
- <dl>
1003
- <dd>
1004
-
1005
- <dl>
1006
- <dd>
1007
-
1008
- Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
1009
-
1010
- </dd>
1011
- </dl>
1012
- </dd>
1013
- </dl>
1014
-
1015
- #### 🔌 Usage
1016
-
1017
- <dl>
1018
- <dd>
1019
-
1020
- <dl>
1021
- <dd>
1022
-
1023
- ```typescript
1024
- await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
1025
- ```
1026
-
1027
- </dd>
1028
- </dl>
1029
- </dd>
1030
- </dl>
1031
-
1032
- #### ⚙️ Parameters
1033
-
1034
- <dl>
1035
- <dd>
1036
-
1037
- <dl>
1038
- <dd>
1039
-
1040
- **sessionId:** `string` — ID of the session that owns the window.
1041
-
1042
- </dd>
1043
- </dl>
1044
-
1045
- <dl>
1046
- <dd>
1047
-
1048
- **request:** `Airtop.CreateWindowInputV1Body`
1049
-
1050
- </dd>
1051
- </dl>
1052
-
1053
- <dl>
1054
- <dd>
1055
-
1056
- **requestOptions:** `Windows.RequestOptions`
1057
-
1058
- </dd>
1059
- </dl>
1060
- </dd>
1061
- </dl>
1062
-
1063
- </dd>
1064
- </dl>
1065
- </details>
1066
-
1067
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
1068
- <dl>
1069
- <dd>
1070
-
1071
- #### 📝 Description
1072
-
1073
- <dl>
1074
- <dd>
1075
-
1076
- <dl>
1077
- <dd>
1078
-
1079
- Get information about a browser window in a session, including the live view url.
1080
-
1081
- </dd>
1082
- </dl>
1083
- </dd>
1084
- </dl>
1085
-
1086
- #### 🔌 Usage
1087
-
1088
- <dl>
1089
- <dd>
1090
-
1091
- <dl>
1092
- <dd>
1093
-
1094
- ```typescript
1095
- await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1096
- screenResolution: "1280x720",
1097
- });
1098
- ```
1099
-
1100
- </dd>
1101
- </dl>
1102
- </dd>
1103
- </dl>
1104
-
1105
- #### ⚙️ Parameters
1106
-
1107
- <dl>
1108
- <dd>
1109
-
1110
- <dl>
1111
- <dd>
1112
-
1113
- **sessionId:** `string` — ID of the session that owns the window.
1114
-
1115
- </dd>
1116
- </dl>
1117
-
1118
- <dl>
1119
- <dd>
1120
-
1121
- **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.
1122
-
1123
- </dd>
1124
- </dl>
1125
-
1126
- <dl>
1127
- <dd>
1128
-
1129
- **request:** `Airtop.GetWindowInfoRequest`
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">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
1149
- <dl>
1150
- <dd>
1151
-
1152
- #### 📝 Description
1153
-
1154
- <dl>
1155
- <dd>
1156
-
1157
- <dl>
1158
- <dd>
1159
-
1160
- Loads a specified url on a given window
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.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1177
- url: "https://www.airtop.ai",
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` — Airtop window ID of the browser window.
1203
-
1204
- </dd>
1205
- </dl>
1206
-
1207
- <dl>
1208
- <dd>
1209
-
1210
- **request:** `Airtop.WindowLoadUrlV1Body`
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">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
1230
- <dl>
1231
- <dd>
1232
-
1233
- #### 📝 Description
1234
-
1235
- <dl>
1236
- <dd>
1237
-
1238
- <dl>
1239
- <dd>
1240
-
1241
- Closes a browser window in a session
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.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
1258
- ```
1259
-
1260
- </dd>
1261
- </dl>
1262
- </dd>
1263
- </dl>
1264
-
1265
- #### ⚙️ Parameters
1266
-
1267
- <dl>
1268
- <dd>
1269
-
1270
- <dl>
1271
- <dd>
1272
-
1273
- **sessionId:** `string` — ID of the session that owns the window.
1274
-
1275
- </dd>
1276
- </dl>
1277
-
1278
- <dl>
1279
- <dd>
1280
-
1281
- **windowId:** `string` — Airtop window ID of the browser window.
1282
-
1283
- </dd>
1284
- </dl>
1285
-
1286
- <dl>
1287
- <dd>
1288
-
1289
- **requestOptions:** `Windows.RequestOptions`
1290
-
1291
- </dd>
1292
- </dl>
1293
- </dd>
1294
- </dl>
1295
-
1296
- </dd>
1297
- </dl>
1298
- </details>
1299
-
1300
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1301
- <dl>
1302
- <dd>
1303
-
1304
- #### 📝 Description
1305
-
1306
- <dl>
1307
- <dd>
1308
-
1309
- <dl>
1310
- <dd>
1311
-
1312
- Execute a click interaction in a specific browser window
1313
-
1314
- </dd>
1315
- </dl>
1316
- </dd>
1317
- </dl>
1318
-
1319
- #### 🔌 Usage
1320
-
1321
- <dl>
1322
- <dd>
1323
-
1324
- <dl>
1325
- <dd>
1326
-
1327
- ```typescript
1328
- await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1329
- elementDescription: "The login button",
1330
- });
1331
- ```
1332
-
1333
- </dd>
1334
- </dl>
1335
- </dd>
1336
- </dl>
1337
-
1338
- #### ⚙️ Parameters
1339
-
1340
- <dl>
1341
- <dd>
1342
-
1343
- <dl>
1344
- <dd>
1345
-
1346
- **sessionId:** `string` — The session id for the window.
1347
-
1348
- </dd>
1349
- </dl>
1350
-
1351
- <dl>
1352
- <dd>
1353
-
1354
- **windowId:** `string` — The Airtop window id of the browser window.
1355
-
1356
- </dd>
1357
- </dl>
1358
-
1359
- <dl>
1360
- <dd>
1361
-
1362
- **request:** `Airtop.SessionClickHandlerRequestBody`
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">createFormFiller</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
- Create a form-filler automation synchronously for the form loaded in the 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.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1410
- ```
1411
-
1412
- </dd>
1413
- </dl>
1414
- </dd>
1415
- </dl>
1416
-
1417
- #### ⚙️ Parameters
1418
-
1419
- <dl>
1420
- <dd>
1421
-
1422
- <dl>
1423
- <dd>
1424
-
1425
- **sessionId:** `string` — The session id for the window.
1426
-
1427
- </dd>
1428
- </dl>
1429
-
1430
- <dl>
1431
- <dd>
1432
-
1433
- **windowId:** `string` — The Airtop window id of the browser window.
1434
-
1435
- </dd>
1436
- </dl>
1437
-
1438
- <dl>
1439
- <dd>
1440
-
1441
- **request:** `Airtop.CreateFormFillerRequest`
1442
-
1443
- </dd>
1444
- </dl>
1445
-
1446
- <dl>
1447
- <dd>
1448
-
1449
- **requestOptions:** `Windows.RequestOptions`
1450
-
1451
- </dd>
1452
- </dl>
1453
- </dd>
1454
- </dl>
1455
-
1456
- </dd>
1457
- </dl>
1458
- </details>
1459
-
1460
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1461
- <dl>
1462
- <dd>
1463
-
1464
- #### 📝 Description
1465
-
1466
- <dl>
1467
- <dd>
1468
-
1469
- <dl>
1470
- <dd>
1471
-
1472
- Fill a form of a browser window synchronously using a form-filler automation
1473
-
1474
- </dd>
1475
- </dl>
1476
- </dd>
1477
- </dl>
1478
-
1479
- #### 🔌 Usage
1480
-
1481
- <dl>
1482
- <dd>
1483
-
1484
- <dl>
1485
- <dd>
1486
-
1487
- ```typescript
1488
- await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1489
- automationId: "automationId",
434
+ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
435
+ screenResolution: "1280x720",
1490
436
  });
1491
437
  ```
1492
438
 
@@ -1503,7 +449,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
1503
449
  <dl>
1504
450
  <dd>
1505
451
 
1506
- **sessionId:** `string` — The session id for the window.
452
+ **sessionId:** `string` — ID of the session that owns the window.
1507
453
 
1508
454
  </dd>
1509
455
  </dl>
@@ -1511,7 +457,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
1511
457
  <dl>
1512
458
  <dd>
1513
459
 
1514
- **windowId:** `string` — The Airtop window id of the browser window.
460
+ **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.
1515
461
 
1516
462
  </dd>
1517
463
  </dl>
@@ -1519,7 +465,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
1519
465
  <dl>
1520
466
  <dd>
1521
467
 
1522
- **request:** `Airtop.FillFormRequest`
468
+ **request:** `Airtop.GetWindowInfoRequest`
1523
469
 
1524
470
  </dd>
1525
471
  </dl>
@@ -1538,7 +484,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
1538
484
  </dl>
1539
485
  </details>
1540
486
 
1541
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
487
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
1542
488
  <dl>
1543
489
  <dd>
1544
490
 
@@ -1550,7 +496,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
1550
496
  <dl>
1551
497
  <dd>
1552
498
 
1553
- Execute a hover interaction in a specific browser window
499
+ Loads a specified url on a given window
1554
500
 
1555
501
  </dd>
1556
502
  </dl>
@@ -1566,8 +512,8 @@ Execute a hover interaction in a specific browser window
1566
512
  <dd>
1567
513
 
1568
514
  ```typescript
1569
- await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1570
- elementDescription: "The search box input in the top right corner",
515
+ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
516
+ url: "https://www.airtop.ai",
1571
517
  });
1572
518
  ```
1573
519
 
@@ -1584,7 +530,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1584
530
  <dl>
1585
531
  <dd>
1586
532
 
1587
- **sessionId:** `string` — The session id for the window.
533
+ **sessionId:** `string` — ID of the session that owns the window.
1588
534
 
1589
535
  </dd>
1590
536
  </dl>
@@ -1592,7 +538,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1592
538
  <dl>
1593
539
  <dd>
1594
540
 
1595
- **windowId:** `string` — The Airtop window id of the browser window.
541
+ **windowId:** `string` — Airtop window ID of the browser window.
1596
542
 
1597
543
  </dd>
1598
544
  </dl>
@@ -1600,7 +546,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1600
546
  <dl>
1601
547
  <dd>
1602
548
 
1603
- **request:** `Airtop.SessionHoverHandlerRequestBody`
549
+ **request:** `Airtop.WindowLoadUrlV1Body`
1604
550
 
1605
551
  </dd>
1606
552
  </dl>
@@ -1619,11 +565,11 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1619
565
  </dl>
1620
566
  </details>
1621
567
 
1622
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
568
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
1623
569
  <dl>
1624
570
  <dd>
1625
571
 
1626
- #### 🔌 Usage
572
+ #### 📝 Description
1627
573
 
1628
574
  <dl>
1629
575
  <dd>
@@ -1631,18 +577,14 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
1631
577
  <dl>
1632
578
  <dd>
1633
579
 
1634
- ```typescript
1635
- await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1636
- condition: "Determine if the user appears to be signed in to the website",
1637
- });
1638
- ```
580
+ Closes a browser window in a session
1639
581
 
1640
582
  </dd>
1641
583
  </dl>
1642
584
  </dd>
1643
585
  </dl>
1644
586
 
1645
- #### ⚙️ Parameters
587
+ #### 🔌 Usage
1646
588
 
1647
589
  <dl>
1648
590
  <dd>
@@ -1650,15 +592,24 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1650
592
  <dl>
1651
593
  <dd>
1652
594
 
1653
- **sessionId:** `string` — The session id for the window.
595
+ ```typescript
596
+ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
597
+ ```
1654
598
 
599
+ </dd>
600
+ </dl>
1655
601
  </dd>
1656
602
  </dl>
1657
603
 
604
+ #### ⚙️ Parameters
605
+
1658
606
  <dl>
1659
607
  <dd>
1660
608
 
1661
- **windowId:** `string` — The Airtop window id of the browser window.
609
+ <dl>
610
+ <dd>
611
+
612
+ **sessionId:** `string` — ID of the session that owns the window.
1662
613
 
1663
614
  </dd>
1664
615
  </dl>
@@ -1666,7 +617,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1666
617
  <dl>
1667
618
  <dd>
1668
619
 
1669
- **request:** `Airtop.SessionMonitorHandlerRequestBody`
620
+ **windowId:** `string` — Airtop window ID of the browser window.
1670
621
 
1671
622
  </dd>
1672
623
  </dl>
@@ -1685,7 +636,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1685
636
  </dl>
1686
637
  </details>
1687
638
 
1688
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">operatorPrompt</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncOperatorPromptResponseEnvelope</code></summary>
639
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1689
640
  <dl>
1690
641
  <dd>
1691
642
 
@@ -1697,7 +648,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1697
648
  <dl>
1698
649
  <dd>
1699
650
 
1700
- Prompt OpenAI Operator
651
+ Execute a click interaction in a specific browser window
1701
652
 
1702
653
  </dd>
1703
654
  </dl>
@@ -1713,8 +664,8 @@ Prompt OpenAI Operator
1713
664
  <dd>
1714
665
 
1715
666
  ```typescript
1716
- await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1717
- prompt: "What is the latest news about OpenAI?",
667
+ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
668
+ elementDescription: "The login button",
1718
669
  });
1719
670
  ```
1720
671
 
@@ -1731,7 +682,7 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
1731
682
  <dl>
1732
683
  <dd>
1733
684
 
1734
- **sessionId:** `string` — ID of the session that owns the window.
685
+ **sessionId:** `string` — The session id for the window.
1735
686
 
1736
687
  </dd>
1737
688
  </dl>
@@ -1739,7 +690,7 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
1739
690
  <dl>
1740
691
  <dd>
1741
692
 
1742
- **windowId:** `string` — Airtop window ID of the browser window.
693
+ **windowId:** `string` — The Airtop window id of the browser window.
1743
694
 
1744
695
  </dd>
1745
696
  </dl>
@@ -1747,7 +698,7 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
1747
698
  <dl>
1748
699
  <dd>
1749
700
 
1750
- **request:** `Airtop.OperatorPromptV1Body`
701
+ **request:** `Airtop.SessionClickHandlerRequestBody`
1751
702
 
1752
703
  </dd>
1753
704
  </dl>
@@ -1766,7 +717,7 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
1766
717
  </dl>
1767
718
  </details>
1768
719
 
1769
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
720
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1770
721
  <dl>
1771
722
  <dd>
1772
723
 
@@ -1778,7 +729,7 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
1778
729
  <dl>
1779
730
  <dd>
1780
731
 
1781
- 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?).
732
+ Create a form-filler automation synchronously for the form loaded in the browser window
1782
733
 
1783
734
  </dd>
1784
735
  </dl>
@@ -1794,9 +745,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
1794
745
  <dd>
1795
746
 
1796
747
  ```typescript
1797
- await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1798
- prompt: "What is the main idea of this page?",
1799
- });
748
+ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1800
749
  ```
1801
750
 
1802
751
  </dd>
@@ -1828,7 +777,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1828
777
  <dl>
1829
778
  <dd>
1830
779
 
1831
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
780
+ **request:** `Airtop.CreateFormFillerRequest`
1832
781
 
1833
782
  </dd>
1834
783
  </dl>
@@ -1847,7 +796,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1847
796
  </dl>
1848
797
  </details>
1849
798
 
1850
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
799
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fileInput</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1851
800
  <dl>
1852
801
  <dd>
1853
802
 
@@ -1859,7 +808,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1859
808
  <dl>
1860
809
  <dd>
1861
810
 
1862
- Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
811
+ Execute a file input interaction in a specific browser window
1863
812
 
1864
813
  </dd>
1865
814
  </dl>
@@ -1875,13 +824,9 @@ Submit a prompt that queries the content of a specific browser window and pagina
1875
824
  <dd>
1876
825
 
1877
826
  ```typescript
1878
- await client.windows.paginatedExtraction(
1879
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
1880
- "0334da2a-91b0-42c5-6156-76a5eba87430",
1881
- {
1882
- 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.",
1883
- },
1884
- );
827
+ await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
828
+ elementDescription: "The file input in the bottom left corner",
829
+ });
1885
830
  ```
1886
831
 
1887
832
  </dd>
@@ -1913,7 +858,7 @@ await client.windows.paginatedExtraction(
1913
858
  <dl>
1914
859
  <dd>
1915
860
 
1916
- **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
861
+ **request:** `Airtop.SessionFileInputHandlerRequestBody`
1917
862
 
1918
863
  </dd>
1919
864
  </dl>
@@ -1932,7 +877,7 @@ await client.windows.paginatedExtraction(
1932
877
  </dl>
1933
878
  </details>
1934
879
 
1935
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
880
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1936
881
  <dl>
1937
882
  <dd>
1938
883
 
@@ -1944,7 +889,7 @@ await client.windows.paginatedExtraction(
1944
889
  <dl>
1945
890
  <dd>
1946
891
 
1947
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
892
+ Fill a form of a browser window synchronously using a form-filler automation
1948
893
 
1949
894
  </dd>
1950
895
  </dl>
@@ -1960,8 +905,8 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
1960
905
  <dd>
1961
906
 
1962
907
  ```typescript
1963
- await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1964
- prompt: "What is the main idea of this page?",
908
+ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
909
+ automationId: "automationId",
1965
910
  });
1966
911
  ```
1967
912
 
@@ -1994,7 +939,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1994
939
  <dl>
1995
940
  <dd>
1996
941
 
1997
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
942
+ **request:** `Airtop.FillFormRequest`
1998
943
 
1999
944
  </dd>
2000
945
  </dl>
@@ -2013,7 +958,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
2013
958
  </dl>
2014
959
  </details>
2015
960
 
2016
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
961
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2017
962
  <dl>
2018
963
  <dd>
2019
964
 
@@ -2025,7 +970,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
2025
970
  <dl>
2026
971
  <dd>
2027
972
 
2028
- Scrape a window and return the content as markdown
973
+ Execute a hover interaction in a specific browser window
2029
974
 
2030
975
  </dd>
2031
976
  </dl>
@@ -2041,7 +986,9 @@ Scrape a window and return the content as markdown
2041
986
  <dd>
2042
987
 
2043
988
  ```typescript
2044
- await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
989
+ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
990
+ elementDescription: "The search box input in the top right corner",
991
+ });
2045
992
  ```
2046
993
 
2047
994
  </dd>
@@ -2065,7 +1012,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
2065
1012
  <dl>
2066
1013
  <dd>
2067
1014
 
2068
- **windowId:** `string` — The Airtop window id of the browser window to scrape.
1015
+ **windowId:** `string` — The Airtop window id of the browser window.
2069
1016
 
2070
1017
  </dd>
2071
1018
  </dl>
@@ -2073,7 +1020,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
2073
1020
  <dl>
2074
1021
  <dd>
2075
1022
 
2076
- **request:** `Airtop.ScrapeContentRequest`
1023
+ **request:** `Airtop.SessionHoverHandlerRequestBody`
2077
1024
 
2078
1025
  </dd>
2079
1026
  </dl>
@@ -2092,25 +1039,10 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
2092
1039
  </dl>
2093
1040
  </details>
2094
1041
 
2095
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2096
- <dl>
2097
- <dd>
2098
-
2099
- #### 📝 Description
2100
-
2101
- <dl>
2102
- <dd>
2103
-
1042
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2104
1043
  <dl>
2105
1044
  <dd>
2106
1045
 
2107
- Take a screenshot of a browser window
2108
-
2109
- </dd>
2110
- </dl>
2111
- </dd>
2112
- </dl>
2113
-
2114
1046
  #### 🔌 Usage
2115
1047
 
2116
1048
  <dl>
@@ -2120,7 +1052,9 @@ Take a screenshot of a browser window
2120
1052
  <dd>
2121
1053
 
2122
1054
  ```typescript
2123
- await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1055
+ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1056
+ condition: "Determine if the user appears to be signed in to the website",
1057
+ });
2124
1058
  ```
2125
1059
 
2126
1060
  </dd>
@@ -2152,7 +1086,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
2152
1086
  <dl>
2153
1087
  <dd>
2154
1088
 
2155
- **request:** `Airtop.SessionScreenshotHandlerRequestBody`
1089
+ **request:** `Airtop.SessionMonitorHandlerRequestBody`
2156
1090
 
2157
1091
  </dd>
2158
1092
  </dl>
@@ -2171,7 +1105,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
2171
1105
  </dl>
2172
1106
  </details>
2173
1107
 
2174
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1108
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2175
1109
  <dl>
2176
1110
  <dd>
2177
1111
 
@@ -2183,7 +1117,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
2183
1117
  <dl>
2184
1118
  <dd>
2185
1119
 
2186
- Execute a scroll interaction in a specific browser window
1120
+ 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?).
2187
1121
 
2188
1122
  </dd>
2189
1123
  </dl>
@@ -2199,7 +1133,9 @@ Execute a scroll interaction in a specific browser window
2199
1133
  <dd>
2200
1134
 
2201
1135
  ```typescript
2202
- await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1136
+ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1137
+ prompt: "What is the main idea of this page?",
1138
+ });
2203
1139
  ```
2204
1140
 
2205
1141
  </dd>
@@ -2231,7 +1167,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
2231
1167
  <dl>
2232
1168
  <dd>
2233
1169
 
2234
- **request:** `Airtop.SessionScrollHandlerRequestBody`
1170
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
2235
1171
 
2236
1172
  </dd>
2237
1173
  </dl>
@@ -2250,7 +1186,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
2250
1186
  </dl>
2251
1187
  </details>
2252
1188
 
2253
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1189
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2254
1190
  <dl>
2255
1191
  <dd>
2256
1192
 
@@ -2262,7 +1198,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
2262
1198
  <dl>
2263
1199
  <dd>
2264
1200
 
2265
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1201
+ Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
2266
1202
 
2267
1203
  </dd>
2268
1204
  </dl>
@@ -2278,7 +1214,13 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
2278
1214
  <dd>
2279
1215
 
2280
1216
  ```typescript
2281
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1217
+ await client.windows.paginatedExtraction(
1218
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
1219
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
1220
+ {
1221
+ 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.",
1222
+ },
1223
+ );
2282
1224
  ```
2283
1225
 
2284
1226
  </dd>
@@ -2302,7 +1244,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
2302
1244
  <dl>
2303
1245
  <dd>
2304
1246
 
2305
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
1247
+ **windowId:** `string` — The Airtop window id of the browser window.
2306
1248
 
2307
1249
  </dd>
2308
1250
  </dl>
@@ -2310,7 +1252,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
2310
1252
  <dl>
2311
1253
  <dd>
2312
1254
 
2313
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
1255
+ **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
2314
1256
 
2315
1257
  </dd>
2316
1258
  </dl>
@@ -2329,7 +1271,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
2329
1271
  </dl>
2330
1272
  </details>
2331
1273
 
2332
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1274
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2333
1275
  <dl>
2334
1276
  <dd>
2335
1277
 
@@ -2341,7 +1283,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
2341
1283
  <dl>
2342
1284
  <dd>
2343
1285
 
2344
- Execute a type interaction in a specific browser window
1286
+ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
2345
1287
 
2346
1288
  </dd>
2347
1289
  </dl>
@@ -2357,8 +1299,8 @@ Execute a type interaction in a specific browser window
2357
1299
  <dd>
2358
1300
 
2359
1301
  ```typescript
2360
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2361
- text: "Example text",
1302
+ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1303
+ prompt: "What is the main idea of this page?",
2362
1304
  });
2363
1305
  ```
2364
1306
 
@@ -2391,7 +1333,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
2391
1333
  <dl>
2392
1334
  <dd>
2393
1335
 
2394
- **request:** `Airtop.SessionTypeHandlerRequestBody`
1336
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
2395
1337
 
2396
1338
  </dd>
2397
1339
  </dl>
@@ -2410,7 +1352,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
2410
1352
  </dl>
2411
1353
  </details>
2412
1354
 
2413
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">act</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1355
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
2414
1356
  <dl>
2415
1357
  <dd>
2416
1358
 
@@ -2422,7 +1364,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
2422
1364
  <dl>
2423
1365
  <dd>
2424
1366
 
2425
- Perform actions in a specific browser window based on a prompt
1367
+ Scrape a window and return the content as markdown
2426
1368
 
2427
1369
  </dd>
2428
1370
  </dl>
@@ -2438,10 +1380,7 @@ Perform actions in a specific browser window based on a prompt
2438
1380
  <dd>
2439
1381
 
2440
1382
  ```typescript
2441
- await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2442
- jobId: "123",
2443
- prompt: "Click the login button",
2444
- });
1383
+ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
2445
1384
  ```
2446
1385
 
2447
1386
  </dd>
@@ -2465,7 +1404,7 @@ await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
2465
1404
  <dl>
2466
1405
  <dd>
2467
1406
 
2468
- **windowId:** `string` — The Airtop window id of the browser window.
1407
+ **windowId:** `string` — The Airtop window id of the browser window to scrape.
2469
1408
 
2470
1409
  </dd>
2471
1410
  </dl>
@@ -2473,7 +1412,7 @@ await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
2473
1412
  <dl>
2474
1413
  <dd>
2475
1414
 
2476
- **request:** `Airtop.ActRequest`
1415
+ **request:** `Airtop.ScrapeContentRequest`
2477
1416
 
2478
1417
  </dd>
2479
1418
  </dl>
@@ -2492,7 +1431,7 @@ await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
2492
1431
  </dl>
2493
1432
  </details>
2494
1433
 
2495
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">extract</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1434
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2496
1435
  <dl>
2497
1436
  <dd>
2498
1437
 
@@ -2504,7 +1443,7 @@ await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
2504
1443
  <dl>
2505
1444
  <dd>
2506
1445
 
2507
- Extract data from a specific browser window based on a prompt
1446
+ Take a screenshot of a browser window
2508
1447
 
2509
1448
  </dd>
2510
1449
  </dl>
@@ -2520,10 +1459,7 @@ Extract data from a specific browser window based on a prompt
2520
1459
  <dd>
2521
1460
 
2522
1461
  ```typescript
2523
- await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2524
- jobId: "123",
2525
- prompt: "Extract all product prices from this page",
2526
- });
1462
+ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
2527
1463
  ```
2528
1464
 
2529
1465
  </dd>
@@ -2555,7 +1491,7 @@ await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
2555
1491
  <dl>
2556
1492
  <dd>
2557
1493
 
2558
- **request:** `Airtop.ExtractRequest`
1494
+ **request:** `Airtop.SessionScreenshotHandlerRequestBody`
2559
1495
 
2560
1496
  </dd>
2561
1497
  </dl>
@@ -2574,7 +1510,7 @@ await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
2574
1510
  </dl>
2575
1511
  </details>
2576
1512
 
2577
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findMany</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1513
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2578
1514
  <dl>
2579
1515
  <dd>
2580
1516
 
@@ -2586,7 +1522,7 @@ await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
2586
1522
  <dl>
2587
1523
  <dd>
2588
1524
 
2589
- Find multiple elements in a browser window based on a prompt
1525
+ Execute a scroll interaction in a specific browser window
2590
1526
 
2591
1527
  </dd>
2592
1528
  </dl>
@@ -2602,10 +1538,7 @@ Find multiple elements in a browser window based on a prompt
2602
1538
  <dd>
2603
1539
 
2604
1540
  ```typescript
2605
- await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2606
- jobId: "123",
2607
- prompt: "Find all the news articles",
2608
- });
1541
+ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
2609
1542
  ```
2610
1543
 
2611
1544
  </dd>
@@ -2637,7 +1570,7 @@ await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
2637
1570
  <dl>
2638
1571
  <dd>
2639
1572
 
2640
- **request:** `Airtop.FindManyRequest`
1573
+ **request:** `Airtop.SessionScrollHandlerRequestBody`
2641
1574
 
2642
1575
  </dd>
2643
1576
  </dl>
@@ -2656,7 +1589,7 @@ await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
2656
1589
  </dl>
2657
1590
  </details>
2658
1591
 
2659
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findOne</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1592
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2660
1593
  <dl>
2661
1594
  <dd>
2662
1595
 
@@ -2668,7 +1601,7 @@ await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
2668
1601
  <dl>
2669
1602
  <dd>
2670
1603
 
2671
- Find a specific element in a browser window based on a prompt
1604
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
2672
1605
 
2673
1606
  </dd>
2674
1607
  </dl>
@@ -2684,10 +1617,7 @@ Find a specific element in a browser window based on a prompt
2684
1617
  <dd>
2685
1618
 
2686
1619
  ```typescript
2687
- await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2688
- jobId: "123",
2689
- prompt: "Find the login button",
2690
- });
1620
+ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
2691
1621
  ```
2692
1622
 
2693
1623
  </dd>
@@ -2711,7 +1641,7 @@ await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
2711
1641
  <dl>
2712
1642
  <dd>
2713
1643
 
2714
- **windowId:** `string` — The Airtop window id of the browser window.
1644
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
2715
1645
 
2716
1646
  </dd>
2717
1647
  </dl>
@@ -2719,7 +1649,7 @@ await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
2719
1649
  <dl>
2720
1650
  <dd>
2721
1651
 
2722
- **request:** `Airtop.FindOneRequest`
1652
+ **request:** `Airtop.SessionSummaryHandlerRequestBody`
2723
1653
 
2724
1654
  </dd>
2725
1655
  </dl>
@@ -2738,7 +1668,7 @@ await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
2738
1668
  </dl>
2739
1669
  </details>
2740
1670
 
2741
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">llm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1671
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2742
1672
  <dl>
2743
1673
  <dd>
2744
1674
 
@@ -2750,7 +1680,7 @@ await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
2750
1680
  <dl>
2751
1681
  <dd>
2752
1682
 
2753
- Send a prompt to an LLM with context from the browser window
1683
+ Execute a type interaction in a specific browser window
2754
1684
 
2755
1685
  </dd>
2756
1686
  </dl>
@@ -2766,8 +1696,8 @@ Send a prompt to an LLM with context from the browser window
2766
1696
  <dd>
2767
1697
 
2768
1698
  ```typescript
2769
- await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2770
- prompt: "Tell me about this webpage",
1699
+ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1700
+ text: "Example text",
2771
1701
  });
2772
1702
  ```
2773
1703
 
@@ -2800,7 +1730,7 @@ await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
2800
1730
  <dl>
2801
1731
  <dd>
2802
1732
 
2803
- **request:** `Airtop.LlmRequest`
1733
+ **request:** `Airtop.SessionTypeHandlerRequestBody`
2804
1734
 
2805
1735
  </dd>
2806
1736
  </dl>
@@ -3283,6 +2213,77 @@ await client.files.delete("id");
3283
2213
  </dl>
3284
2214
  </details>
3285
2215
 
2216
+ <details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">push</a>(id, { ...params }) -> void</code></summary>
2217
+ <dl>
2218
+ <dd>
2219
+
2220
+ #### 📝 Description
2221
+
2222
+ <dl>
2223
+ <dd>
2224
+
2225
+ <dl>
2226
+ <dd>
2227
+
2228
+ Push a file to one or more sessions, making it available for the sessions to use
2229
+
2230
+ </dd>
2231
+ </dl>
2232
+ </dd>
2233
+ </dl>
2234
+
2235
+ #### 🔌 Usage
2236
+
2237
+ <dl>
2238
+ <dd>
2239
+
2240
+ <dl>
2241
+ <dd>
2242
+
2243
+ ```typescript
2244
+ await client.files.push("id");
2245
+ ```
2246
+
2247
+ </dd>
2248
+ </dl>
2249
+ </dd>
2250
+ </dl>
2251
+
2252
+ #### ⚙️ Parameters
2253
+
2254
+ <dl>
2255
+ <dd>
2256
+
2257
+ <dl>
2258
+ <dd>
2259
+
2260
+ **id:** `string` — ID of the file
2261
+
2262
+ </dd>
2263
+ </dl>
2264
+
2265
+ <dl>
2266
+ <dd>
2267
+
2268
+ **request:** `Airtop.PushFileBodyV1`
2269
+
2270
+ </dd>
2271
+ </dl>
2272
+
2273
+ <dl>
2274
+ <dd>
2275
+
2276
+ **requestOptions:** `Files.RequestOptions`
2277
+
2278
+ </dd>
2279
+ </dl>
2280
+ </dd>
2281
+ </dl>
2282
+
2283
+ </dd>
2284
+ </dl>
2285
+ </details>
2286
+
3286
2287
  ## Profiles
3287
2288
 
3288
2289
  <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>