@airtop/sdk 0.1.38 → 0.1.40-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.
Files changed (197) hide show
  1. package/README.md +9 -10
  2. package/api/errors/index.d.ts +2 -2
  3. package/api/errors/index.js +2 -2
  4. package/api/resources/automations/client/Client.js +12 -12
  5. package/api/resources/files/client/Client.js +12 -12
  6. package/api/resources/profiles/client/Client.js +3 -3
  7. package/api/resources/requests/client/Client.js +3 -3
  8. package/api/resources/sessions/client/Client.js +18 -18
  9. package/api/resources/sessions/types/SessionsEventsResponse.d.ts +10 -10
  10. package/api/resources/sessions/types/index.d.ts +3 -3
  11. package/api/resources/sessions/types/index.js +3 -3
  12. package/api/resources/windows/client/Client.d.ts +200 -0
  13. package/api/resources/windows/client/Client.js +1056 -211
  14. package/api/resources/windows/client/requests/ActRequest.d.ts +30 -0
  15. package/api/resources/windows/client/requests/ActRequest.js +5 -0
  16. package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
  17. package/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
  18. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
  19. package/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
  20. package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
  21. package/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
  22. package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
  23. package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
  24. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
  25. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
  26. package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
  27. package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
  28. package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
  29. package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
  30. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
  31. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
  32. package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
  33. package/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
  34. package/api/resources/windows/client/requests/ExtractRequest.d.ts +30 -0
  35. package/api/resources/windows/client/requests/ExtractRequest.js +5 -0
  36. package/api/resources/windows/client/requests/FindManyRequest.d.ts +30 -0
  37. package/api/resources/windows/client/requests/FindManyRequest.js +5 -0
  38. package/api/resources/windows/client/requests/FindOneRequest.d.ts +30 -0
  39. package/api/resources/windows/client/requests/FindOneRequest.js +5 -0
  40. package/api/resources/windows/client/requests/LlmRequest.d.ts +25 -0
  41. package/api/resources/windows/client/requests/LlmRequest.js +5 -0
  42. package/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +25 -0
  43. package/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
  44. package/api/resources/windows/client/requests/index.d.ts +15 -0
  45. package/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
  46. package/api/types/AsyncOperatorPromptResponseEnvelope.js +5 -0
  47. package/api/types/RequestStatusResponse.d.ts +2 -0
  48. package/api/types/SessionConfigV1.d.ts +2 -0
  49. package/api/types/index.d.ts +1 -0
  50. package/api/types/index.js +1 -0
  51. package/dist/api/errors/index.d.ts +2 -2
  52. package/dist/api/errors/index.js +2 -2
  53. package/dist/api/resources/automations/client/Client.js +12 -12
  54. package/dist/api/resources/files/client/Client.js +12 -12
  55. package/dist/api/resources/profiles/client/Client.js +3 -3
  56. package/dist/api/resources/requests/client/Client.js +3 -3
  57. package/dist/api/resources/sessions/client/Client.js +18 -18
  58. package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +10 -10
  59. package/dist/api/resources/sessions/types/index.d.ts +3 -3
  60. package/dist/api/resources/sessions/types/index.js +3 -3
  61. package/dist/api/resources/windows/client/Client.d.ts +200 -0
  62. package/dist/api/resources/windows/client/Client.js +1056 -211
  63. package/dist/api/resources/windows/client/requests/ActRequest.d.ts +30 -0
  64. package/dist/api/resources/windows/client/requests/ActRequest.js +5 -0
  65. package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
  66. package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
  67. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
  68. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
  69. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
  70. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
  71. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
  72. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
  73. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
  74. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
  75. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
  76. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
  77. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
  78. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
  79. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
  80. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
  81. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
  82. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
  83. package/dist/api/resources/windows/client/requests/ExtractRequest.d.ts +30 -0
  84. package/dist/api/resources/windows/client/requests/ExtractRequest.js +5 -0
  85. package/dist/api/resources/windows/client/requests/FindManyRequest.d.ts +30 -0
  86. package/dist/api/resources/windows/client/requests/FindManyRequest.js +5 -0
  87. package/dist/api/resources/windows/client/requests/FindOneRequest.d.ts +30 -0
  88. package/dist/api/resources/windows/client/requests/FindOneRequest.js +5 -0
  89. package/dist/api/resources/windows/client/requests/LlmRequest.d.ts +25 -0
  90. package/dist/api/resources/windows/client/requests/LlmRequest.js +5 -0
  91. package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +25 -0
  92. package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
  93. package/dist/api/resources/windows/client/requests/index.d.ts +15 -0
  94. package/dist/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
  95. package/dist/api/types/AsyncOperatorPromptResponseEnvelope.js +5 -0
  96. package/dist/api/types/RequestStatusResponse.d.ts +2 -0
  97. package/dist/api/types/SessionConfigV1.d.ts +2 -0
  98. package/dist/api/types/index.d.ts +1 -0
  99. package/dist/api/types/index.js +1 -0
  100. package/dist/environments.d.ts +1 -1
  101. package/dist/environments.js +1 -1
  102. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +13 -13
  103. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +6 -6
  104. package/dist/serialization/resources/sessions/types/index.d.ts +3 -3
  105. package/dist/serialization/resources/sessions/types/index.js +3 -3
  106. package/dist/serialization/resources/windows/client/requests/ActRequest.d.ts +19 -0
  107. package/dist/serialization/resources/windows/client/requests/ActRequest.js +50 -0
  108. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
  109. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
  110. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
  111. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
  112. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
  113. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
  114. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
  115. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
  116. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
  117. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
  118. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
  119. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
  120. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
  121. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
  122. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
  123. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
  124. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
  125. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
  126. package/dist/serialization/resources/windows/client/requests/ExtractRequest.d.ts +19 -0
  127. package/dist/serialization/resources/windows/client/requests/ExtractRequest.js +50 -0
  128. package/dist/serialization/resources/windows/client/requests/FindManyRequest.d.ts +19 -0
  129. package/dist/serialization/resources/windows/client/requests/FindManyRequest.js +50 -0
  130. package/dist/serialization/resources/windows/client/requests/FindOneRequest.d.ts +19 -0
  131. package/dist/serialization/resources/windows/client/requests/FindOneRequest.js +50 -0
  132. package/dist/serialization/resources/windows/client/requests/LlmRequest.d.ts +17 -0
  133. package/dist/serialization/resources/windows/client/requests/LlmRequest.js +48 -0
  134. package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +17 -0
  135. package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
  136. package/dist/serialization/resources/windows/client/requests/index.d.ts +15 -0
  137. package/dist/serialization/resources/windows/client/requests/index.js +31 -1
  138. package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
  139. package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
  140. package/dist/serialization/types/RequestStatusResponse.d.ts +1 -0
  141. package/dist/serialization/types/RequestStatusResponse.js +1 -0
  142. package/dist/serialization/types/SessionConfigV1.d.ts +1 -0
  143. package/dist/serialization/types/SessionConfigV1.js +1 -0
  144. package/dist/serialization/types/index.d.ts +1 -0
  145. package/dist/serialization/types/index.js +1 -0
  146. package/dist/version.d.ts +1 -1
  147. package/dist/version.js +1 -1
  148. package/environments.d.ts +1 -1
  149. package/environments.js +1 -1
  150. package/package.json +1 -1
  151. package/reference.md +1291 -140
  152. package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +13 -13
  153. package/serialization/resources/sessions/types/SessionsEventsResponse.js +6 -6
  154. package/serialization/resources/sessions/types/index.d.ts +3 -3
  155. package/serialization/resources/sessions/types/index.js +3 -3
  156. package/serialization/resources/windows/client/requests/ActRequest.d.ts +19 -0
  157. package/serialization/resources/windows/client/requests/ActRequest.js +50 -0
  158. package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
  159. package/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
  160. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
  161. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
  162. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
  163. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
  164. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
  165. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
  166. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
  167. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
  168. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
  169. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
  170. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
  171. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
  172. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
  173. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
  174. package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
  175. package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
  176. package/serialization/resources/windows/client/requests/ExtractRequest.d.ts +19 -0
  177. package/serialization/resources/windows/client/requests/ExtractRequest.js +50 -0
  178. package/serialization/resources/windows/client/requests/FindManyRequest.d.ts +19 -0
  179. package/serialization/resources/windows/client/requests/FindManyRequest.js +50 -0
  180. package/serialization/resources/windows/client/requests/FindOneRequest.d.ts +19 -0
  181. package/serialization/resources/windows/client/requests/FindOneRequest.js +50 -0
  182. package/serialization/resources/windows/client/requests/LlmRequest.d.ts +17 -0
  183. package/serialization/resources/windows/client/requests/LlmRequest.js +48 -0
  184. package/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +17 -0
  185. package/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
  186. package/serialization/resources/windows/client/requests/index.d.ts +15 -0
  187. package/serialization/resources/windows/client/requests/index.js +31 -1
  188. package/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
  189. package/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
  190. package/serialization/types/RequestStatusResponse.d.ts +1 -0
  191. package/serialization/types/RequestStatusResponse.js +1 -0
  192. package/serialization/types/SessionConfigV1.d.ts +1 -0
  193. package/serialization/types/SessionConfigV1.js +1 -0
  194. package/serialization/types/index.d.ts +1 -0
  195. package/serialization/types/index.js +1 -0
  196. package/version.d.ts +1 -1
  197. package/version.js +1 -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>
@@ -65,7 +146,1068 @@ await client.windows.asyncCreateAutomation(
65
146
  <dl>
66
147
  <dd>
67
148
 
68
- **request:** `Airtop.AsyncCreateAutomationRequest`
149
+ **request:** `Airtop.AsyncCreateAutomationRequest`
150
+
151
+ </dd>
152
+ </dl>
153
+
154
+ <dl>
155
+ <dd>
156
+
157
+ **requestOptions:** `Windows.RequestOptions`
158
+
159
+ </dd>
160
+ </dl>
161
+ </dd>
162
+ </dl>
163
+
164
+ </dd>
165
+ </dl>
166
+ </details>
167
+
168
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
169
+ <dl>
170
+ <dd>
171
+
172
+ #### 📝 Description
173
+
174
+ <dl>
175
+ <dd>
176
+
177
+ <dl>
178
+ <dd>
179
+
180
+ Create a form filler automation asynchronously
181
+
182
+ </dd>
183
+ </dl>
184
+ </dd>
185
+ </dl>
186
+
187
+ #### 🔌 Usage
188
+
189
+ <dl>
190
+ <dd>
191
+
192
+ <dl>
193
+ <dd>
194
+
195
+ ```typescript
196
+ await client.windows.asyncCreateFormFiller(
197
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
198
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
199
+ );
200
+ ```
201
+
202
+ </dd>
203
+ </dl>
204
+ </dd>
205
+ </dl>
206
+
207
+ #### ⚙️ Parameters
208
+
209
+ <dl>
210
+ <dd>
211
+
212
+ <dl>
213
+ <dd>
214
+
215
+ **sessionId:** `string` — The session id for the window.
216
+
217
+ </dd>
218
+ </dl>
219
+
220
+ <dl>
221
+ <dd>
222
+
223
+ **windowId:** `string` — The Airtop window id of the browser window.
224
+
225
+ </dd>
226
+ </dl>
227
+
228
+ <dl>
229
+ <dd>
230
+
231
+ **request:** `Airtop.AsyncCreateFormFillerRequest`
232
+
233
+ </dd>
234
+ </dl>
235
+
236
+ <dl>
237
+ <dd>
238
+
239
+ **requestOptions:** `Windows.RequestOptions`
240
+
241
+ </dd>
242
+ </dl>
243
+ </dd>
244
+ </dl>
245
+
246
+ </dd>
247
+ </dl>
248
+ </details>
249
+
250
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
251
+ <dl>
252
+ <dd>
253
+
254
+ #### 📝 Description
255
+
256
+ <dl>
257
+ <dd>
258
+
259
+ <dl>
260
+ <dd>
261
+
262
+ Execute an automation of a browser window asynchronously
263
+
264
+ </dd>
265
+ </dl>
266
+ </dd>
267
+ </dl>
268
+
269
+ #### 🔌 Usage
270
+
271
+ <dl>
272
+ <dd>
273
+
274
+ <dl>
275
+ <dd>
276
+
277
+ ```typescript
278
+ await client.windows.asyncExecuteAutomation(
279
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
280
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
281
+ {
282
+ automationId: "automationId",
283
+ },
284
+ );
285
+ ```
286
+
287
+ </dd>
288
+ </dl>
289
+ </dd>
290
+ </dl>
291
+
292
+ #### ⚙️ Parameters
293
+
294
+ <dl>
295
+ <dd>
296
+
297
+ <dl>
298
+ <dd>
299
+
300
+ **sessionId:** `string` — The session id for the window.
301
+
302
+ </dd>
303
+ </dl>
304
+
305
+ <dl>
306
+ <dd>
307
+
308
+ **windowId:** `string` — The Airtop window id of the browser window.
309
+
310
+ </dd>
311
+ </dl>
312
+
313
+ <dl>
314
+ <dd>
315
+
316
+ **request:** `Airtop.AsyncExecuteAutomationRequest`
317
+
318
+ </dd>
319
+ </dl>
320
+
321
+ <dl>
322
+ <dd>
323
+
324
+ **requestOptions:** `Windows.RequestOptions`
325
+
326
+ </dd>
327
+ </dl>
328
+ </dd>
329
+ </dl>
330
+
331
+ </dd>
332
+ </dl>
333
+ </details>
334
+
335
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</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
+ Fill a form of a browser window asynchronously using a form-filler automation
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.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
364
+ automationId: "automationId",
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.AsyncFillFormRequest`
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
+
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
+
452
+ <dl>
453
+ <dd>
454
+
455
+ **windowId:** `string` — The Airtop window id of the browser window.
456
+
457
+ </dd>
458
+ </dl>
459
+
460
+ <dl>
461
+ <dd>
462
+
463
+ **request:** `Airtop.AsyncHoverRequest`
464
+
465
+ </dd>
466
+ </dl>
467
+
468
+ <dl>
469
+ <dd>
470
+
471
+ **requestOptions:** `Windows.RequestOptions`
472
+
473
+ </dd>
474
+ </dl>
475
+ </dd>
476
+ </dl>
477
+
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
+ #### 🔌 Usage
487
+
488
+ <dl>
489
+ <dd>
490
+
491
+ <dl>
492
+ <dd>
493
+
494
+ ```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
+ });
498
+ ```
499
+
500
+ </dd>
501
+ </dl>
502
+ </dd>
503
+ </dl>
504
+
505
+ #### ⚙️ Parameters
506
+
507
+ <dl>
508
+ <dd>
509
+
510
+ <dl>
511
+ <dd>
512
+
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.
522
+
523
+ </dd>
524
+ </dl>
525
+
526
+ <dl>
527
+ <dd>
528
+
529
+ **request:** `Airtop.AsyncMonitorRequest`
530
+
531
+ </dd>
532
+ </dl>
533
+
534
+ <dl>
535
+ <dd>
536
+
537
+ **requestOptions:** `Windows.RequestOptions`
538
+
539
+ </dd>
540
+ </dl>
541
+ </dd>
542
+ </dl>
543
+
544
+ </dd>
545
+ </dl>
546
+ </details>
547
+
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
+
584
+ <dl>
585
+ <dd>
586
+
587
+ **windowId:** `string` — The Airtop window id of the browser window.
588
+
589
+ </dd>
590
+ </dl>
591
+
592
+ <dl>
593
+ <dd>
594
+
595
+ **request:** `Airtop.AsyncPageQueryRequest`
596
+
597
+ </dd>
598
+ </dl>
599
+
600
+ <dl>
601
+ <dd>
602
+
603
+ **requestOptions:** `Windows.RequestOptions`
604
+
605
+ </dd>
606
+ </dl>
607
+ </dd>
608
+ </dl>
609
+
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
+ #### 🔌 Usage
619
+
620
+ <dl>
621
+ <dd>
622
+
623
+ <dl>
624
+ <dd>
625
+
626
+ ```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`
69
1211
 
70
1212
  </dd>
71
1213
  </dl>
@@ -84,7 +1226,7 @@ await client.windows.asyncCreateAutomation(
84
1226
  </dl>
85
1227
  </details>
86
1228
 
87
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1229
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
88
1230
  <dl>
89
1231
  <dd>
90
1232
 
@@ -96,7 +1238,7 @@ await client.windows.asyncCreateAutomation(
96
1238
  <dl>
97
1239
  <dd>
98
1240
 
99
- Create a form filler automation asynchronously
1241
+ Closes a browser window in a session
100
1242
 
101
1243
  </dd>
102
1244
  </dl>
@@ -112,10 +1254,7 @@ Create a form filler automation asynchronously
112
1254
  <dd>
113
1255
 
114
1256
  ```typescript
115
- await client.windows.asyncCreateFormFiller(
116
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
117
- "0334da2a-91b0-42c5-6156-76a5eba87430",
118
- );
1257
+ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
119
1258
  ```
120
1259
 
121
1260
  </dd>
@@ -131,15 +1270,7 @@ await client.windows.asyncCreateFormFiller(
131
1270
  <dl>
132
1271
  <dd>
133
1272
 
134
- **sessionId:** `string` — The session id for the window.
135
-
136
- </dd>
137
- </dl>
138
-
139
- <dl>
140
- <dd>
141
-
142
- **windowId:** `string` — The Airtop window id of the browser window.
1273
+ **sessionId:** `string` — ID of the session that owns the window.
143
1274
 
144
1275
  </dd>
145
1276
  </dl>
@@ -147,7 +1278,7 @@ await client.windows.asyncCreateFormFiller(
147
1278
  <dl>
148
1279
  <dd>
149
1280
 
150
- **request:** `Airtop.AsyncCreateFormFillerRequest`
1281
+ **windowId:** `string` — Airtop window ID of the browser window.
151
1282
 
152
1283
  </dd>
153
1284
  </dl>
@@ -166,7 +1297,7 @@ await client.windows.asyncCreateFormFiller(
166
1297
  </dl>
167
1298
  </details>
168
1299
 
169
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1300
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
170
1301
  <dl>
171
1302
  <dd>
172
1303
 
@@ -178,7 +1309,7 @@ await client.windows.asyncCreateFormFiller(
178
1309
  <dl>
179
1310
  <dd>
180
1311
 
181
- Execute an automation of a browser window asynchronously
1312
+ Execute a click interaction in a specific browser window
182
1313
 
183
1314
  </dd>
184
1315
  </dl>
@@ -194,13 +1325,9 @@ Execute an automation of a browser window asynchronously
194
1325
  <dd>
195
1326
 
196
1327
  ```typescript
197
- await client.windows.asyncExecuteAutomation(
198
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
199
- "0334da2a-91b0-42c5-6156-76a5eba87430",
200
- {
201
- automationId: "automationId",
202
- },
203
- );
1328
+ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1329
+ elementDescription: "The login button",
1330
+ });
204
1331
  ```
205
1332
 
206
1333
  </dd>
@@ -232,7 +1359,7 @@ await client.windows.asyncExecuteAutomation(
232
1359
  <dl>
233
1360
  <dd>
234
1361
 
235
- **request:** `Airtop.AsyncExecuteAutomationRequest`
1362
+ **request:** `Airtop.SessionClickHandlerRequestBody`
236
1363
 
237
1364
  </dd>
238
1365
  </dl>
@@ -251,7 +1378,7 @@ await client.windows.asyncExecuteAutomation(
251
1378
  </dl>
252
1379
  </details>
253
1380
 
254
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1381
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
255
1382
  <dl>
256
1383
  <dd>
257
1384
 
@@ -263,7 +1390,7 @@ await client.windows.asyncExecuteAutomation(
263
1390
  <dl>
264
1391
  <dd>
265
1392
 
266
- Fill a form of a browser window asynchronously using a form-filler automation
1393
+ Create a form-filler automation synchronously for the form loaded in the browser window
267
1394
 
268
1395
  </dd>
269
1396
  </dl>
@@ -279,9 +1406,7 @@ Fill a form of a browser window asynchronously using a form-filler automation
279
1406
  <dd>
280
1407
 
281
1408
  ```typescript
282
- await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
283
- automationId: "automationId",
284
- });
1409
+ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
285
1410
  ```
286
1411
 
287
1412
  </dd>
@@ -313,7 +1438,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
313
1438
  <dl>
314
1439
  <dd>
315
1440
 
316
- **request:** `Airtop.AsyncFillFormRequest`
1441
+ **request:** `Airtop.CreateFormFillerRequest`
317
1442
 
318
1443
  </dd>
319
1444
  </dl>
@@ -332,7 +1457,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
332
1457
  </dl>
333
1458
  </details>
334
1459
 
335
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
1460
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
336
1461
  <dl>
337
1462
  <dd>
338
1463
 
@@ -344,7 +1469,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
344
1469
  <dl>
345
1470
  <dd>
346
1471
 
347
- Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
1472
+ Fill a form of a browser window synchronously using a form-filler automation
348
1473
 
349
1474
  </dd>
350
1475
  </dl>
@@ -360,7 +1485,9 @@ Creates a new browser window in a session. Optionally, you can specify a url to
360
1485
  <dd>
361
1486
 
362
1487
  ```typescript
363
- await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
1488
+ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1489
+ automationId: "automationId",
1490
+ });
364
1491
  ```
365
1492
 
366
1493
  </dd>
@@ -376,7 +1503,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
376
1503
  <dl>
377
1504
  <dd>
378
1505
 
379
- **sessionId:** `string` — ID of the session that owns the window.
1506
+ **sessionId:** `string` — The session id for the window.
380
1507
 
381
1508
  </dd>
382
1509
  </dl>
@@ -384,7 +1511,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
384
1511
  <dl>
385
1512
  <dd>
386
1513
 
387
- **request:** `Airtop.CreateWindowInputV1Body`
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.FillFormRequest`
388
1523
 
389
1524
  </dd>
390
1525
  </dl>
@@ -403,7 +1538,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
403
1538
  </dl>
404
1539
  </details>
405
1540
 
406
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
1541
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
407
1542
  <dl>
408
1543
  <dd>
409
1544
 
@@ -415,7 +1550,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
415
1550
  <dl>
416
1551
  <dd>
417
1552
 
418
- Get information about a browser window in a session, including the live view url.
1553
+ Execute a hover interaction in a specific browser window
419
1554
 
420
1555
  </dd>
421
1556
  </dl>
@@ -431,8 +1566,8 @@ Get information about a browser window in a session, including the live view url
431
1566
  <dd>
432
1567
 
433
1568
  ```typescript
434
- await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
435
- screenResolution: "1280x720",
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",
436
1571
  });
437
1572
  ```
438
1573
 
@@ -449,7 +1584,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
449
1584
  <dl>
450
1585
  <dd>
451
1586
 
452
- **sessionId:** `string` — ID of the session that owns the window.
1587
+ **sessionId:** `string` — The session id for the window.
453
1588
 
454
1589
  </dd>
455
1590
  </dl>
@@ -457,7 +1592,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
457
1592
  <dl>
458
1593
  <dd>
459
1594
 
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.
1595
+ **windowId:** `string` — The Airtop window id of the browser window.
461
1596
 
462
1597
  </dd>
463
1598
  </dl>
@@ -465,7 +1600,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
465
1600
  <dl>
466
1601
  <dd>
467
1602
 
468
- **request:** `Airtop.GetWindowInfoRequest`
1603
+ **request:** `Airtop.SessionHoverHandlerRequestBody`
469
1604
 
470
1605
  </dd>
471
1606
  </dl>
@@ -484,25 +1619,10 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
484
1619
  </dl>
485
1620
  </details>
486
1621
 
487
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
488
- <dl>
489
- <dd>
490
-
491
- #### 📝 Description
492
-
493
- <dl>
494
- <dd>
495
-
1622
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
496
1623
  <dl>
497
1624
  <dd>
498
1625
 
499
- Loads a specified url on a given window
500
-
501
- </dd>
502
- </dl>
503
- </dd>
504
- </dl>
505
-
506
1626
  #### 🔌 Usage
507
1627
 
508
1628
  <dl>
@@ -512,8 +1632,8 @@ Loads a specified url on a given window
512
1632
  <dd>
513
1633
 
514
1634
  ```typescript
515
- await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
516
- url: "https://www.airtop.ai",
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",
517
1637
  });
518
1638
  ```
519
1639
 
@@ -530,7 +1650,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
530
1650
  <dl>
531
1651
  <dd>
532
1652
 
533
- **sessionId:** `string` — ID of the session that owns the window.
1653
+ **sessionId:** `string` — The session id for the window.
534
1654
 
535
1655
  </dd>
536
1656
  </dl>
@@ -538,7 +1658,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
538
1658
  <dl>
539
1659
  <dd>
540
1660
 
541
- **windowId:** `string` — Airtop window ID of the browser window.
1661
+ **windowId:** `string` — The Airtop window id of the browser window.
542
1662
 
543
1663
  </dd>
544
1664
  </dl>
@@ -546,7 +1666,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
546
1666
  <dl>
547
1667
  <dd>
548
1668
 
549
- **request:** `Airtop.WindowLoadUrlV1Body`
1669
+ **request:** `Airtop.SessionMonitorHandlerRequestBody`
550
1670
 
551
1671
  </dd>
552
1672
  </dl>
@@ -565,7 +1685,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
565
1685
  </dl>
566
1686
  </details>
567
1687
 
568
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
1688
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">operatorPrompt</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncOperatorPromptResponseEnvelope</code></summary>
569
1689
  <dl>
570
1690
  <dd>
571
1691
 
@@ -577,7 +1697,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
577
1697
  <dl>
578
1698
  <dd>
579
1699
 
580
- Closes a browser window in a session
1700
+ Prompt OpenAI Operator
581
1701
 
582
1702
  </dd>
583
1703
  </dl>
@@ -593,7 +1713,9 @@ Closes a browser window in a session
593
1713
  <dd>
594
1714
 
595
1715
  ```typescript
596
- await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
1716
+ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1717
+ prompt: "What is the latest news about OpenAI?",
1718
+ });
597
1719
  ```
598
1720
 
599
1721
  </dd>
@@ -625,6 +1747,14 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
625
1747
  <dl>
626
1748
  <dd>
627
1749
 
1750
+ **request:** `Airtop.OperatorPromptV1Body`
1751
+
1752
+ </dd>
1753
+ </dl>
1754
+
1755
+ <dl>
1756
+ <dd>
1757
+
628
1758
  **requestOptions:** `Windows.RequestOptions`
629
1759
 
630
1760
  </dd>
@@ -636,7 +1766,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
636
1766
  </dl>
637
1767
  </details>
638
1768
 
639
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1769
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
640
1770
  <dl>
641
1771
  <dd>
642
1772
 
@@ -648,7 +1778,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
648
1778
  <dl>
649
1779
  <dd>
650
1780
 
651
- Execute a click interaction in a specific browser window
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?).
652
1782
 
653
1783
  </dd>
654
1784
  </dl>
@@ -664,8 +1794,8 @@ Execute a click interaction in a specific browser window
664
1794
  <dd>
665
1795
 
666
1796
  ```typescript
667
- await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
668
- elementDescription: "The login button",
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?",
669
1799
  });
670
1800
  ```
671
1801
 
@@ -698,7 +1828,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
698
1828
  <dl>
699
1829
  <dd>
700
1830
 
701
- **request:** `Airtop.SessionClickHandlerRequestBody`
1831
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
702
1832
 
703
1833
  </dd>
704
1834
  </dl>
@@ -717,7 +1847,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
717
1847
  </dl>
718
1848
  </details>
719
1849
 
720
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1850
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
721
1851
  <dl>
722
1852
  <dd>
723
1853
 
@@ -729,7 +1859,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
729
1859
  <dl>
730
1860
  <dd>
731
1861
 
732
- Create a form-filler automation synchronously for the form loaded in the browser window
1862
+ Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
733
1863
 
734
1864
  </dd>
735
1865
  </dl>
@@ -745,7 +1875,13 @@ Create a form-filler automation synchronously for the form loaded in the browser
745
1875
  <dd>
746
1876
 
747
1877
  ```typescript
748
- await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
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
+ );
749
1885
  ```
750
1886
 
751
1887
  </dd>
@@ -777,7 +1913,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
777
1913
  <dl>
778
1914
  <dd>
779
1915
 
780
- **request:** `Airtop.CreateFormFillerRequest`
1916
+ **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
781
1917
 
782
1918
  </dd>
783
1919
  </dl>
@@ -796,7 +1932,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
796
1932
  </dl>
797
1933
  </details>
798
1934
 
799
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1935
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
800
1936
  <dl>
801
1937
  <dd>
802
1938
 
@@ -808,7 +1944,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
808
1944
  <dl>
809
1945
  <dd>
810
1946
 
811
- Fill a form of a browser window synchronously using a form-filler automation
1947
+ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
812
1948
 
813
1949
  </dd>
814
1950
  </dl>
@@ -824,8 +1960,8 @@ Fill a form of a browser window synchronously using a form-filler automation
824
1960
  <dd>
825
1961
 
826
1962
  ```typescript
827
- await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
828
- automationId: "automationId",
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?",
829
1965
  });
830
1966
  ```
831
1967
 
@@ -858,7 +1994,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
858
1994
  <dl>
859
1995
  <dd>
860
1996
 
861
- **request:** `Airtop.FillFormRequest`
1997
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
862
1998
 
863
1999
  </dd>
864
2000
  </dl>
@@ -877,7 +2013,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
877
2013
  </dl>
878
2014
  </details>
879
2015
 
880
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2016
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
881
2017
  <dl>
882
2018
  <dd>
883
2019
 
@@ -889,7 +2025,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
889
2025
  <dl>
890
2026
  <dd>
891
2027
 
892
- Execute a hover interaction in a specific browser window
2028
+ Scrape a window and return the content as markdown
893
2029
 
894
2030
  </dd>
895
2031
  </dl>
@@ -905,9 +2041,7 @@ Execute a hover interaction in a specific browser window
905
2041
  <dd>
906
2042
 
907
2043
  ```typescript
908
- await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
909
- elementDescription: "The search box input in the top right corner",
910
- });
2044
+ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
911
2045
  ```
912
2046
 
913
2047
  </dd>
@@ -931,7 +2065,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
931
2065
  <dl>
932
2066
  <dd>
933
2067
 
934
- **windowId:** `string` — The Airtop window id of the browser window.
2068
+ **windowId:** `string` — The Airtop window id of the browser window to scrape.
935
2069
 
936
2070
  </dd>
937
2071
  </dl>
@@ -939,7 +2073,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
939
2073
  <dl>
940
2074
  <dd>
941
2075
 
942
- **request:** `Airtop.SessionHoverHandlerRequestBody`
2076
+ **request:** `Airtop.ScrapeContentRequest`
943
2077
 
944
2078
  </dd>
945
2079
  </dl>
@@ -958,10 +2092,25 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
958
2092
  </dl>
959
2093
  </details>
960
2094
 
961
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
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
+
962
2104
  <dl>
963
2105
  <dd>
964
2106
 
2107
+ Take a screenshot of a browser window
2108
+
2109
+ </dd>
2110
+ </dl>
2111
+ </dd>
2112
+ </dl>
2113
+
965
2114
  #### 🔌 Usage
966
2115
 
967
2116
  <dl>
@@ -971,9 +2120,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
971
2120
  <dd>
972
2121
 
973
2122
  ```typescript
974
- await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
975
- condition: "Determine if the user appears to be signed in to the website",
976
- });
2123
+ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
977
2124
  ```
978
2125
 
979
2126
  </dd>
@@ -1005,7 +2152,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1005
2152
  <dl>
1006
2153
  <dd>
1007
2154
 
1008
- **request:** `Airtop.SessionMonitorHandlerRequestBody`
2155
+ **request:** `Airtop.SessionScreenshotHandlerRequestBody`
1009
2156
 
1010
2157
  </dd>
1011
2158
  </dl>
@@ -1024,7 +2171,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1024
2171
  </dl>
1025
2172
  </details>
1026
2173
 
1027
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2174
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1028
2175
  <dl>
1029
2176
  <dd>
1030
2177
 
@@ -1036,7 +2183,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1036
2183
  <dl>
1037
2184
  <dd>
1038
2185
 
1039
- 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?).
2186
+ Execute a scroll interaction in a specific browser window
1040
2187
 
1041
2188
  </dd>
1042
2189
  </dl>
@@ -1052,9 +2199,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
1052
2199
  <dd>
1053
2200
 
1054
2201
  ```typescript
1055
- await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1056
- prompt: "What is the main idea of this page?",
1057
- });
2202
+ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1058
2203
  ```
1059
2204
 
1060
2205
  </dd>
@@ -1086,7 +2231,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1086
2231
  <dl>
1087
2232
  <dd>
1088
2233
 
1089
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
2234
+ **request:** `Airtop.SessionScrollHandlerRequestBody`
1090
2235
 
1091
2236
  </dd>
1092
2237
  </dl>
@@ -1105,7 +2250,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1105
2250
  </dl>
1106
2251
  </details>
1107
2252
 
1108
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2253
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1109
2254
  <dl>
1110
2255
  <dd>
1111
2256
 
@@ -1117,7 +2262,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
1117
2262
  <dl>
1118
2263
  <dd>
1119
2264
 
1120
- Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
2265
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1121
2266
 
1122
2267
  </dd>
1123
2268
  </dl>
@@ -1133,13 +2278,7 @@ Submit a prompt that queries the content of a specific browser window and pagina
1133
2278
  <dd>
1134
2279
 
1135
2280
  ```typescript
1136
- await client.windows.paginatedExtraction(
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
- );
2281
+ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1143
2282
  ```
1144
2283
 
1145
2284
  </dd>
@@ -1163,7 +2302,7 @@ await client.windows.paginatedExtraction(
1163
2302
  <dl>
1164
2303
  <dd>
1165
2304
 
1166
- **windowId:** `string` — The Airtop window id of the browser window.
2305
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
1167
2306
 
1168
2307
  </dd>
1169
2308
  </dl>
@@ -1171,7 +2310,7 @@ await client.windows.paginatedExtraction(
1171
2310
  <dl>
1172
2311
  <dd>
1173
2312
 
1174
- **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
2313
+ **request:** `Airtop.SessionSummaryHandlerRequestBody`
1175
2314
 
1176
2315
  </dd>
1177
2316
  </dl>
@@ -1190,7 +2329,7 @@ await client.windows.paginatedExtraction(
1190
2329
  </dl>
1191
2330
  </details>
1192
2331
 
1193
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2332
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1194
2333
  <dl>
1195
2334
  <dd>
1196
2335
 
@@ -1202,7 +2341,7 @@ await client.windows.paginatedExtraction(
1202
2341
  <dl>
1203
2342
  <dd>
1204
2343
 
1205
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
2344
+ Execute a type interaction in a specific browser window
1206
2345
 
1207
2346
  </dd>
1208
2347
  </dl>
@@ -1218,8 +2357,8 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
1218
2357
  <dd>
1219
2358
 
1220
2359
  ```typescript
1221
- await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1222
- prompt: "What is the main idea of this page?",
2360
+ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2361
+ text: "Example text",
1223
2362
  });
1224
2363
  ```
1225
2364
 
@@ -1252,7 +2391,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1252
2391
  <dl>
1253
2392
  <dd>
1254
2393
 
1255
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
2394
+ **request:** `Airtop.SessionTypeHandlerRequestBody`
1256
2395
 
1257
2396
  </dd>
1258
2397
  </dl>
@@ -1271,7 +2410,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1271
2410
  </dl>
1272
2411
  </details>
1273
2412
 
1274
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
2413
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">act</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1275
2414
  <dl>
1276
2415
  <dd>
1277
2416
 
@@ -1283,7 +2422,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1283
2422
  <dl>
1284
2423
  <dd>
1285
2424
 
1286
- Scrape a window and return the content as markdown
2425
+ Perform actions in a specific browser window based on a prompt
1287
2426
 
1288
2427
  </dd>
1289
2428
  </dl>
@@ -1299,7 +2438,10 @@ Scrape a window and return the content as markdown
1299
2438
  <dd>
1300
2439
 
1301
2440
  ```typescript
1302
- await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
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
+ });
1303
2445
  ```
1304
2446
 
1305
2447
  </dd>
@@ -1323,7 +2465,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1323
2465
  <dl>
1324
2466
  <dd>
1325
2467
 
1326
- **windowId:** `string` — The Airtop window id of the browser window to scrape.
2468
+ **windowId:** `string` — The Airtop window id of the browser window.
1327
2469
 
1328
2470
  </dd>
1329
2471
  </dl>
@@ -1331,7 +2473,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1331
2473
  <dl>
1332
2474
  <dd>
1333
2475
 
1334
- **request:** `Airtop.ScrapeContentRequest`
2476
+ **request:** `Airtop.ActRequest`
1335
2477
 
1336
2478
  </dd>
1337
2479
  </dl>
@@ -1350,7 +2492,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1350
2492
  </dl>
1351
2493
  </details>
1352
2494
 
1353
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2495
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">extract</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1354
2496
  <dl>
1355
2497
  <dd>
1356
2498
 
@@ -1362,7 +2504,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
1362
2504
  <dl>
1363
2505
  <dd>
1364
2506
 
1365
- Take a screenshot of a browser window
2507
+ Extract data from a specific browser window based on a prompt
1366
2508
 
1367
2509
  </dd>
1368
2510
  </dl>
@@ -1378,7 +2520,10 @@ Take a screenshot of a browser window
1378
2520
  <dd>
1379
2521
 
1380
2522
  ```typescript
1381
- await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
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
+ });
1382
2527
  ```
1383
2528
 
1384
2529
  </dd>
@@ -1410,7 +2555,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
1410
2555
  <dl>
1411
2556
  <dd>
1412
2557
 
1413
- **request:** `Airtop.SessionScreenshotHandlerRequestBody`
2558
+ **request:** `Airtop.ExtractRequest`
1414
2559
 
1415
2560
  </dd>
1416
2561
  </dl>
@@ -1429,7 +2574,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
1429
2574
  </dl>
1430
2575
  </details>
1431
2576
 
1432
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2577
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findMany</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1433
2578
  <dl>
1434
2579
  <dd>
1435
2580
 
@@ -1441,7 +2586,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
1441
2586
  <dl>
1442
2587
  <dd>
1443
2588
 
1444
- Execute a scroll interaction in a specific browser window
2589
+ Find multiple elements in a browser window based on a prompt
1445
2590
 
1446
2591
  </dd>
1447
2592
  </dl>
@@ -1457,7 +2602,10 @@ Execute a scroll interaction in a specific browser window
1457
2602
  <dd>
1458
2603
 
1459
2604
  ```typescript
1460
- await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
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
+ });
1461
2609
  ```
1462
2610
 
1463
2611
  </dd>
@@ -1489,7 +2637,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1489
2637
  <dl>
1490
2638
  <dd>
1491
2639
 
1492
- **request:** `Airtop.SessionScrollHandlerRequestBody`
2640
+ **request:** `Airtop.FindManyRequest`
1493
2641
 
1494
2642
  </dd>
1495
2643
  </dl>
@@ -1508,7 +2656,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1508
2656
  </dl>
1509
2657
  </details>
1510
2658
 
1511
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2659
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findOne</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1512
2660
  <dl>
1513
2661
  <dd>
1514
2662
 
@@ -1520,7 +2668,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1520
2668
  <dl>
1521
2669
  <dd>
1522
2670
 
1523
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
2671
+ Find a specific element in a browser window based on a prompt
1524
2672
 
1525
2673
  </dd>
1526
2674
  </dl>
@@ -1536,7 +2684,10 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
1536
2684
  <dd>
1537
2685
 
1538
2686
  ```typescript
1539
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
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
+ });
1540
2691
  ```
1541
2692
 
1542
2693
  </dd>
@@ -1560,7 +2711,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1560
2711
  <dl>
1561
2712
  <dd>
1562
2713
 
1563
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
2714
+ **windowId:** `string` — The Airtop window id of the browser window.
1564
2715
 
1565
2716
  </dd>
1566
2717
  </dl>
@@ -1568,7 +2719,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1568
2719
  <dl>
1569
2720
  <dd>
1570
2721
 
1571
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
2722
+ **request:** `Airtop.FindOneRequest`
1572
2723
 
1573
2724
  </dd>
1574
2725
  </dl>
@@ -1587,7 +2738,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1587
2738
  </dl>
1588
2739
  </details>
1589
2740
 
1590
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
2741
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">llm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
1591
2742
  <dl>
1592
2743
  <dd>
1593
2744
 
@@ -1599,7 +2750,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1599
2750
  <dl>
1600
2751
  <dd>
1601
2752
 
1602
- Execute a type interaction in a specific browser window
2753
+ Send a prompt to an LLM with context from the browser window
1603
2754
 
1604
2755
  </dd>
1605
2756
  </dl>
@@ -1615,8 +2766,8 @@ Execute a type interaction in a specific browser window
1615
2766
  <dd>
1616
2767
 
1617
2768
  ```typescript
1618
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1619
- text: "Example text",
2769
+ await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
2770
+ prompt: "Tell me about this webpage",
1620
2771
  });
1621
2772
  ```
1622
2773
 
@@ -1649,7 +2800,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
1649
2800
  <dl>
1650
2801
  <dd>
1651
2802
 
1652
- **request:** `Airtop.SessionTypeHandlerRequestBody`
2803
+ **request:** `Airtop.LlmRequest`
1653
2804
 
1654
2805
  </dd>
1655
2806
  </dl>