@airtop/sdk 0.1.31-beta2 → 0.1.32

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 (265) hide show
  1. package/Client.d.ts +0 -6
  2. package/Client.js +6 -16
  3. package/README.md +6 -8
  4. package/api/errors/index.d.ts +0 -2
  5. package/api/errors/index.js +0 -2
  6. package/api/resources/index.d.ts +0 -3
  7. package/api/resources/index.js +1 -4
  8. package/api/resources/profiles/client/Client.js +2 -2
  9. package/api/resources/requests/client/Client.js +2 -2
  10. package/api/resources/sessions/client/Client.d.ts +0 -9
  11. package/api/resources/sessions/client/Client.js +12 -65
  12. package/api/resources/windows/client/Client.d.ts +0 -138
  13. package/api/resources/windows/client/Client.js +30 -729
  14. package/api/resources/windows/client/requests/index.d.ts +0 -11
  15. package/api/types/SessionConfigV1.d.ts +0 -2
  16. package/api/types/index.d.ts +0 -7
  17. package/api/types/index.js +0 -7
  18. package/dist/Client.d.ts +0 -6
  19. package/dist/Client.js +6 -16
  20. package/dist/api/errors/index.d.ts +0 -2
  21. package/dist/api/errors/index.js +0 -2
  22. package/dist/api/resources/index.d.ts +0 -3
  23. package/dist/api/resources/index.js +1 -4
  24. package/dist/api/resources/profiles/client/Client.js +2 -2
  25. package/dist/api/resources/requests/client/Client.js +2 -2
  26. package/dist/api/resources/sessions/client/Client.d.ts +0 -9
  27. package/dist/api/resources/sessions/client/Client.js +12 -65
  28. package/dist/api/resources/windows/client/Client.d.ts +0 -138
  29. package/dist/api/resources/windows/client/Client.js +30 -729
  30. package/dist/api/resources/windows/client/requests/index.d.ts +0 -11
  31. package/dist/api/types/SessionConfigV1.d.ts +0 -2
  32. package/dist/api/types/index.d.ts +0 -7
  33. package/dist/api/types/index.js +0 -7
  34. package/dist/serialization/resources/index.d.ts +0 -2
  35. package/dist/serialization/resources/index.js +1 -3
  36. package/dist/serialization/resources/windows/client/requests/index.d.ts +0 -11
  37. package/dist/serialization/resources/windows/client/requests/index.js +1 -23
  38. package/dist/serialization/types/SessionConfigV1.d.ts +0 -1
  39. package/dist/serialization/types/SessionConfigV1.js +0 -1
  40. package/dist/serialization/types/index.d.ts +0 -7
  41. package/dist/serialization/types/index.js +0 -7
  42. package/dist/wrapper/AirtopClient.d.ts +0 -1
  43. package/dist/wrapper/AirtopClient.js +0 -3
  44. package/dist/wrapper/AirtopWindows.d.ts +1 -1
  45. package/package.json +2 -3
  46. package/reference.md +155 -1298
  47. package/serialization/resources/index.d.ts +0 -2
  48. package/serialization/resources/index.js +1 -3
  49. package/serialization/resources/windows/client/requests/index.d.ts +0 -11
  50. package/serialization/resources/windows/client/requests/index.js +1 -23
  51. package/serialization/types/SessionConfigV1.d.ts +0 -1
  52. package/serialization/types/SessionConfigV1.js +0 -1
  53. package/serialization/types/index.d.ts +0 -7
  54. package/serialization/types/index.js +0 -7
  55. package/wrapper/AirtopClient.d.ts +0 -1
  56. package/wrapper/AirtopClient.js +0 -3
  57. package/wrapper/AirtopWindows.d.ts +1 -1
  58. package/api/errors/ForbiddenError.d.ts +0 -8
  59. package/api/errors/ForbiddenError.js +0 -41
  60. package/api/errors/UnauthorizedError.d.ts +0 -8
  61. package/api/errors/UnauthorizedError.js +0 -41
  62. package/api/resources/automations/client/Client.d.ts +0 -87
  63. package/api/resources/automations/client/Client.js +0 -451
  64. package/api/resources/automations/client/index.d.ts +0 -1
  65. package/api/resources/automations/client/index.js +0 -17
  66. package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -19
  67. package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -5
  68. package/api/resources/automations/client/requests/index.d.ts +0 -1
  69. package/api/resources/automations/client/requests/index.js +0 -2
  70. package/api/resources/automations/index.d.ts +0 -1
  71. package/api/resources/automations/index.js +0 -17
  72. package/api/resources/extensionConfigurations/client/Client.d.ts +0 -40
  73. package/api/resources/extensionConfigurations/client/Client.js +0 -149
  74. package/api/resources/extensionConfigurations/client/index.d.ts +0 -1
  75. package/api/resources/extensionConfigurations/client/index.js +0 -2
  76. package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +0 -13
  77. package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +0 -5
  78. package/api/resources/extensionConfigurations/client/requests/index.d.ts +0 -1
  79. package/api/resources/extensionConfigurations/client/requests/index.js +0 -2
  80. package/api/resources/extensionConfigurations/index.d.ts +0 -1
  81. package/api/resources/extensionConfigurations/index.js +0 -17
  82. package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
  83. package/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
  84. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -23
  85. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -5
  86. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -27
  87. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -5
  88. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  89. package/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
  90. package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  91. package/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
  92. package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  93. package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
  94. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  95. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
  96. package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  97. package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
  98. package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
  99. package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  100. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
  101. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  102. package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  103. package/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  104. package/api/types/AsyncConfig.d.ts +0 -7
  105. package/api/types/AsyncConfig.js +0 -5
  106. package/api/types/AsyncSessionAiResponseEnvelope.d.ts +0 -9
  107. package/api/types/AsyncSessionAiResponseEnvelope.js +0 -5
  108. package/api/types/AutomationOutput.d.ts +0 -10
  109. package/api/types/AutomationOutput.js +0 -5
  110. package/api/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -4
  111. package/api/types/CreateAutomationRequestBodyConfiguration.js +0 -5
  112. package/api/types/DeleteAutomationOutputWrapperBody.d.ts +0 -4
  113. package/api/types/DeleteAutomationOutputWrapperBody.js +0 -5
  114. package/api/types/ExtensionConfigurationOutput.d.ts +0 -13
  115. package/api/types/ExtensionConfigurationOutput.js +0 -5
  116. package/api/types/ListAutomationsOutput.d.ts +0 -7
  117. package/api/types/ListAutomationsOutput.js +0 -5
  118. package/dist/api/errors/ForbiddenError.d.ts +0 -8
  119. package/dist/api/errors/ForbiddenError.js +0 -41
  120. package/dist/api/errors/UnauthorizedError.d.ts +0 -8
  121. package/dist/api/errors/UnauthorizedError.js +0 -41
  122. package/dist/api/resources/automations/client/Client.d.ts +0 -87
  123. package/dist/api/resources/automations/client/Client.js +0 -451
  124. package/dist/api/resources/automations/client/index.d.ts +0 -1
  125. package/dist/api/resources/automations/client/index.js +0 -17
  126. package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -19
  127. package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -5
  128. package/dist/api/resources/automations/client/requests/index.d.ts +0 -1
  129. package/dist/api/resources/automations/client/requests/index.js +0 -2
  130. package/dist/api/resources/automations/index.d.ts +0 -1
  131. package/dist/api/resources/automations/index.js +0 -17
  132. package/dist/api/resources/extensionConfigurations/client/Client.d.ts +0 -40
  133. package/dist/api/resources/extensionConfigurations/client/Client.js +0 -149
  134. package/dist/api/resources/extensionConfigurations/client/index.d.ts +0 -1
  135. package/dist/api/resources/extensionConfigurations/client/index.js +0 -2
  136. package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +0 -13
  137. package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +0 -5
  138. package/dist/api/resources/extensionConfigurations/client/requests/index.d.ts +0 -1
  139. package/dist/api/resources/extensionConfigurations/client/requests/index.js +0 -2
  140. package/dist/api/resources/extensionConfigurations/index.d.ts +0 -1
  141. package/dist/api/resources/extensionConfigurations/index.js +0 -17
  142. package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
  143. package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
  144. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -23
  145. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -5
  146. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -27
  147. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -5
  148. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
  149. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
  150. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
  151. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
  152. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
  153. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
  154. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
  155. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
  156. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
  157. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
  158. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
  159. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
  160. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
  161. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
  162. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
  163. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
  164. package/dist/api/types/AsyncConfig.d.ts +0 -7
  165. package/dist/api/types/AsyncConfig.js +0 -5
  166. package/dist/api/types/AsyncSessionAiResponseEnvelope.d.ts +0 -9
  167. package/dist/api/types/AsyncSessionAiResponseEnvelope.js +0 -5
  168. package/dist/api/types/AutomationOutput.d.ts +0 -10
  169. package/dist/api/types/AutomationOutput.js +0 -5
  170. package/dist/api/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -4
  171. package/dist/api/types/CreateAutomationRequestBodyConfiguration.js +0 -5
  172. package/dist/api/types/DeleteAutomationOutputWrapperBody.d.ts +0 -4
  173. package/dist/api/types/DeleteAutomationOutputWrapperBody.js +0 -5
  174. package/dist/api/types/ExtensionConfigurationOutput.d.ts +0 -13
  175. package/dist/api/types/ExtensionConfigurationOutput.js +0 -5
  176. package/dist/api/types/ListAutomationsOutput.d.ts +0 -7
  177. package/dist/api/types/ListAutomationsOutput.js +0 -5
  178. package/dist/serialization/resources/automations/client/index.d.ts +0 -1
  179. package/dist/serialization/resources/automations/client/index.js +0 -17
  180. package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -14
  181. package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -35
  182. package/dist/serialization/resources/automations/client/requests/index.d.ts +0 -1
  183. package/dist/serialization/resources/automations/client/requests/index.js +0 -5
  184. package/dist/serialization/resources/automations/index.d.ts +0 -1
  185. package/dist/serialization/resources/automations/index.js +0 -17
  186. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
  187. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -41
  188. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -18
  189. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -39
  190. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -18
  191. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -39
  192. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -19
  193. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -40
  194. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -19
  195. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -40
  196. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
  197. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -41
  198. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  199. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -40
  200. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  201. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -41
  202. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
  203. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -39
  204. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  205. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -40
  206. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  207. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -45
  208. package/dist/serialization/types/AsyncConfig.d.ts +0 -12
  209. package/dist/serialization/types/AsyncConfig.js +0 -33
  210. package/dist/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +0 -15
  211. package/dist/serialization/types/AsyncSessionAiResponseEnvelope.js +0 -36
  212. package/dist/serialization/types/AutomationOutput.d.ts +0 -16
  213. package/dist/serialization/types/AutomationOutput.js +0 -37
  214. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -10
  215. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.js +0 -31
  216. package/dist/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +0 -10
  217. package/dist/serialization/types/DeleteAutomationOutputWrapperBody.js +0 -31
  218. package/dist/serialization/types/ExtensionConfigurationOutput.d.ts +0 -15
  219. package/dist/serialization/types/ExtensionConfigurationOutput.js +0 -36
  220. package/dist/serialization/types/ListAutomationsOutput.d.ts +0 -13
  221. package/dist/serialization/types/ListAutomationsOutput.js +0 -34
  222. package/serialization/resources/automations/client/index.d.ts +0 -1
  223. package/serialization/resources/automations/client/index.js +0 -17
  224. package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +0 -14
  225. package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +0 -35
  226. package/serialization/resources/automations/client/requests/index.d.ts +0 -1
  227. package/serialization/resources/automations/client/requests/index.js +0 -5
  228. package/serialization/resources/automations/index.d.ts +0 -1
  229. package/serialization/resources/automations/index.js +0 -17
  230. package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
  231. package/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -41
  232. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +0 -18
  233. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +0 -39
  234. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +0 -18
  235. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +0 -39
  236. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -19
  237. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -40
  238. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -19
  239. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -40
  240. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
  241. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -41
  242. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
  243. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -40
  244. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
  245. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -41
  246. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
  247. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -39
  248. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
  249. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -40
  250. package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
  251. package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -45
  252. package/serialization/types/AsyncConfig.d.ts +0 -12
  253. package/serialization/types/AsyncConfig.js +0 -33
  254. package/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +0 -15
  255. package/serialization/types/AsyncSessionAiResponseEnvelope.js +0 -36
  256. package/serialization/types/AutomationOutput.d.ts +0 -16
  257. package/serialization/types/AutomationOutput.js +0 -37
  258. package/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +0 -10
  259. package/serialization/types/CreateAutomationRequestBodyConfiguration.js +0 -31
  260. package/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +0 -10
  261. package/serialization/types/DeleteAutomationOutputWrapperBody.js +0 -31
  262. package/serialization/types/ExtensionConfigurationOutput.d.ts +0 -15
  263. package/serialization/types/ExtensionConfigurationOutput.js +0 -36
  264. package/serialization/types/ListAutomationsOutput.d.ts +0 -13
  265. package/serialization/types/ListAutomationsOutput.js +0 -34
package/reference.md CHANGED
@@ -2,7 +2,7 @@
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>
5
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
6
6
  <dl>
7
7
  <dd>
8
8
 
@@ -14,7 +14,7 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- Execute a click interaction in a specific browser window asynchronously
17
+ Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
18
18
 
19
19
  </dd>
20
20
  </dl>
@@ -30,9 +30,7 @@ Execute a click interaction in a specific browser window asynchronously
30
30
  <dd>
31
31
 
32
32
  ```typescript
33
- await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
34
- elementDescription: "The login button",
35
- });
33
+ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
36
34
  ```
37
35
 
38
36
  </dd>
@@ -48,15 +46,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
48
46
  <dl>
49
47
  <dd>
50
48
 
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.
49
+ **sessionId:** `string` — ID of the session that owns the window.
60
50
 
61
51
  </dd>
62
52
  </dl>
@@ -64,7 +54,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
64
54
  <dl>
65
55
  <dd>
66
56
 
67
- **request:** `Airtop.AsyncClickRequest`
57
+ **request:** `Airtop.CreateWindowInputV1Body`
68
58
 
69
59
  </dd>
70
60
  </dl>
@@ -83,7 +73,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
83
73
  </dl>
84
74
  </details>
85
75
 
86
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
76
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
87
77
  <dl>
88
78
  <dd>
89
79
 
@@ -95,7 +85,7 @@ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
95
85
  <dl>
96
86
  <dd>
97
87
 
98
- Create an automation of a browser window asynchronously
88
+ Get information about a browser window in a session, including the live view url.
99
89
 
100
90
  </dd>
101
91
  </dl>
@@ -111,10 +101,9 @@ Create an automation of a browser window asynchronously
111
101
  <dd>
112
102
 
113
103
  ```typescript
114
- await client.windows.asyncCreateAutomation(
115
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
116
- "0334da2a-91b0-42c5-6156-76a5eba87430"
117
- );
104
+ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
105
+ screenResolution: "1280x720",
106
+ });
118
107
  ```
119
108
 
120
109
  </dd>
@@ -130,7 +119,7 @@ await client.windows.asyncCreateAutomation(
130
119
  <dl>
131
120
  <dd>
132
121
 
133
- **sessionId:** `string` — The session id for the window.
122
+ **sessionId:** `string` — ID of the session that owns the window.
134
123
 
135
124
  </dd>
136
125
  </dl>
@@ -138,7 +127,7 @@ await client.windows.asyncCreateAutomation(
138
127
  <dl>
139
128
  <dd>
140
129
 
141
- **windowId:** `string` — The Airtop window id of the browser window.
130
+ **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.
142
131
 
143
132
  </dd>
144
133
  </dl>
@@ -146,7 +135,7 @@ await client.windows.asyncCreateAutomation(
146
135
  <dl>
147
136
  <dd>
148
137
 
149
- **request:** `Airtop.AsyncCreateAutomationRequest`
138
+ **request:** `Airtop.GetWindowInfoRequest`
150
139
 
151
140
  </dd>
152
141
  </dl>
@@ -165,7 +154,7 @@ await client.windows.asyncCreateAutomation(
165
154
  </dl>
166
155
  </details>
167
156
 
168
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
157
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
169
158
  <dl>
170
159
  <dd>
171
160
 
@@ -177,7 +166,7 @@ await client.windows.asyncCreateAutomation(
177
166
  <dl>
178
167
  <dd>
179
168
 
180
- Execute an automation of a browser window asynchronously
169
+ Loads a specified url on a given window
181
170
 
182
171
  </dd>
183
172
  </dl>
@@ -193,13 +182,9 @@ Execute an automation of a browser window asynchronously
193
182
  <dd>
194
183
 
195
184
  ```typescript
196
- await client.windows.asyncExecuteAutomation(
197
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
198
- "0334da2a-91b0-42c5-6156-76a5eba87430",
199
- {
200
- automationId: "automationId",
201
- }
202
- );
185
+ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
186
+ url: "https://www.airtop.ai",
187
+ });
203
188
  ```
204
189
 
205
190
  </dd>
@@ -215,7 +200,7 @@ await client.windows.asyncExecuteAutomation(
215
200
  <dl>
216
201
  <dd>
217
202
 
218
- **sessionId:** `string` — The session id for the window.
203
+ **sessionId:** `string` — ID of the session that owns the window.
219
204
 
220
205
  </dd>
221
206
  </dl>
@@ -223,7 +208,7 @@ await client.windows.asyncExecuteAutomation(
223
208
  <dl>
224
209
  <dd>
225
210
 
226
- **windowId:** `string` — The Airtop window id of the browser window.
211
+ **windowId:** `string` — Airtop window ID of the browser window.
227
212
 
228
213
  </dd>
229
214
  </dl>
@@ -231,7 +216,7 @@ await client.windows.asyncExecuteAutomation(
231
216
  <dl>
232
217
  <dd>
233
218
 
234
- **request:** `Airtop.AsyncExecuteAutomationRequest`
219
+ **request:** `Airtop.WindowLoadUrlV1Body`
235
220
 
236
221
  </dd>
237
222
  </dl>
@@ -250,11 +235,11 @@ await client.windows.asyncExecuteAutomation(
250
235
  </dl>
251
236
  </details>
252
237
 
253
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
238
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
254
239
  <dl>
255
240
  <dd>
256
241
 
257
- #### 🔌 Usage
242
+ #### 📝 Description
258
243
 
259
244
  <dl>
260
245
  <dd>
@@ -262,18 +247,14 @@ await client.windows.asyncExecuteAutomation(
262
247
  <dl>
263
248
  <dd>
264
249
 
265
- ```typescript
266
- await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
267
- elementDescription: "The search box input in the top right corner",
268
- });
269
- ```
250
+ Closes a browser window in a session
270
251
 
271
252
  </dd>
272
253
  </dl>
273
254
  </dd>
274
255
  </dl>
275
256
 
276
- #### ⚙️ Parameters
257
+ #### 🔌 Usage
277
258
 
278
259
  <dl>
279
260
  <dd>
@@ -281,15 +262,24 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
281
262
  <dl>
282
263
  <dd>
283
264
 
284
- **sessionId:** `string` — The session id for the window.
265
+ ```typescript
266
+ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
267
+ ```
285
268
 
286
269
  </dd>
287
270
  </dl>
271
+ </dd>
272
+ </dl>
273
+
274
+ #### ⚙️ Parameters
288
275
 
289
276
  <dl>
290
277
  <dd>
291
278
 
292
- **windowId:** `string` — The Airtop window id of the browser window.
279
+ <dl>
280
+ <dd>
281
+
282
+ **sessionId:** `string` — ID of the session that owns the window.
293
283
 
294
284
  </dd>
295
285
  </dl>
@@ -297,7 +287,7 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
297
287
  <dl>
298
288
  <dd>
299
289
 
300
- **request:** `Airtop.AsyncHoverRequest`
290
+ **windowId:** `string` — Airtop window ID of the browser window.
301
291
 
302
292
  </dd>
303
293
  </dl>
@@ -316,10 +306,25 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
316
306
  </dl>
317
307
  </details>
318
308
 
319
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
309
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
310
+ <dl>
311
+ <dd>
312
+
313
+ #### 📝 Description
314
+
315
+ <dl>
316
+ <dd>
317
+
320
318
  <dl>
321
319
  <dd>
322
320
 
321
+ Execute a click interaction in a specific browser window
322
+
323
+ </dd>
324
+ </dl>
325
+ </dd>
326
+ </dl>
327
+
323
328
  #### 🔌 Usage
324
329
 
325
330
  <dl>
@@ -329,8 +334,8 @@ await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
329
334
  <dd>
330
335
 
331
336
  ```typescript
332
- await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
333
- condition: "Determine if the user appears to be signed in to the website",
337
+ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
338
+ elementDescription: "The login button",
334
339
  });
335
340
  ```
336
341
 
@@ -363,7 +368,7 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
363
368
  <dl>
364
369
  <dd>
365
370
 
366
- **request:** `Airtop.AsyncMonitorRequest`
371
+ **request:** `Airtop.SessionClickHandlerRequestBody`
367
372
 
368
373
  </dd>
369
374
  </dl>
@@ -382,10 +387,25 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
382
387
  </dl>
383
388
  </details>
384
389
 
385
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
390
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
391
+ <dl>
392
+ <dd>
393
+
394
+ #### 📝 Description
395
+
396
+ <dl>
397
+ <dd>
398
+
386
399
  <dl>
387
400
  <dd>
388
401
 
402
+ Execute a hover interaction in a specific browser window
403
+
404
+ </dd>
405
+ </dl>
406
+ </dd>
407
+ </dl>
408
+
389
409
  #### 🔌 Usage
390
410
 
391
411
  <dl>
@@ -395,8 +415,8 @@ await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334d
395
415
  <dd>
396
416
 
397
417
  ```typescript
398
- await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
399
- prompt: "What is the main idea of this page?",
418
+ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
419
+ elementDescription: "The search box input in the top right corner",
400
420
  });
401
421
  ```
402
422
 
@@ -429,7 +449,7 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
429
449
  <dl>
430
450
  <dd>
431
451
 
432
- **request:** `Airtop.AsyncPageQueryRequest`
452
+ **request:** `Airtop.SessionHoverHandlerRequestBody`
433
453
 
434
454
  </dd>
435
455
  </dl>
@@ -448,7 +468,7 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
448
468
  </dl>
449
469
  </details>
450
470
 
451
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
471
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
452
472
  <dl>
453
473
  <dd>
454
474
 
@@ -461,13 +481,9 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
461
481
  <dd>
462
482
 
463
483
  ```typescript
464
- await client.windows.asyncPaginatedExtraction(
465
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
466
- "0334da2a-91b0-42c5-6156-76a5eba87430",
467
- {
468
- 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.",
469
- }
470
- );
484
+ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
485
+ condition: "Determine if the user appears to be signed in to the website",
486
+ });
471
487
  ```
472
488
 
473
489
  </dd>
@@ -499,7 +515,7 @@ await client.windows.asyncPaginatedExtraction(
499
515
  <dl>
500
516
  <dd>
501
517
 
502
- **request:** `Airtop.AsyncPaginatedExtractionRequest`
518
+ **request:** `Airtop.SessionMonitorHandlerRequestBody`
503
519
 
504
520
  </dd>
505
521
  </dl>
@@ -518,7 +534,7 @@ await client.windows.asyncPaginatedExtraction(
518
534
  </dl>
519
535
  </details>
520
536
 
521
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
537
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
522
538
  <dl>
523
539
  <dd>
524
540
 
@@ -530,7 +546,7 @@ await client.windows.asyncPaginatedExtraction(
530
546
  <dl>
531
547
  <dd>
532
548
 
533
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
549
+ 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?).
534
550
 
535
551
  </dd>
536
552
  </dl>
@@ -546,13 +562,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
546
562
  <dd>
547
563
 
548
564
  ```typescript
549
- await client.windows.asyncPromptContent(
550
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
551
- "0334da2a-91b0-42c5-6156-76a5eba87430",
552
- {
553
- prompt: "What is the main idea of this page?",
554
- }
555
- );
565
+ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
566
+ prompt: "What is the main idea of this page?",
567
+ });
556
568
  ```
557
569
 
558
570
  </dd>
@@ -584,7 +596,7 @@ await client.windows.asyncPromptContent(
584
596
  <dl>
585
597
  <dd>
586
598
 
587
- **request:** `Airtop.AsyncPromptContentRequest`
599
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
588
600
 
589
601
  </dd>
590
602
  </dl>
@@ -603,7 +615,7 @@ await client.windows.asyncPromptContent(
603
615
  </dl>
604
616
  </details>
605
617
 
606
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
618
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
607
619
  <dl>
608
620
  <dd>
609
621
 
@@ -615,7 +627,7 @@ await client.windows.asyncPromptContent(
615
627
  <dl>
616
628
  <dd>
617
629
 
618
- Take a screenshot of the current viewport of a browser window asynchronously
630
+ Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
619
631
 
620
632
  </dd>
621
633
  </dl>
@@ -631,7 +643,13 @@ Take a screenshot of the current viewport of a browser window asynchronously
631
643
  <dd>
632
644
 
633
645
  ```typescript
634
- await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
646
+ await client.windows.paginatedExtraction(
647
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
648
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
649
+ {
650
+ 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.",
651
+ }
652
+ );
635
653
  ```
636
654
 
637
655
  </dd>
@@ -663,7 +681,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
663
681
  <dl>
664
682
  <dd>
665
683
 
666
- **request:** `Airtop.AsyncScreenshotRequest`
684
+ **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
667
685
 
668
686
  </dd>
669
687
  </dl>
@@ -682,7 +700,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
682
700
  </dl>
683
701
  </details>
684
702
 
685
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
703
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
686
704
  <dl>
687
705
  <dd>
688
706
 
@@ -694,7 +712,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
694
712
  <dl>
695
713
  <dd>
696
714
 
697
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
715
+ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
698
716
 
699
717
  </dd>
700
718
  </dl>
@@ -710,10 +728,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
710
728
  <dd>
711
729
 
712
730
  ```typescript
713
- await client.windows.asyncSummarizeContent(
714
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
715
- "0334da2a-91b0-42c5-6156-76a5eba87430"
716
- );
731
+ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
732
+ prompt: "What is the main idea of this page?",
733
+ });
717
734
  ```
718
735
 
719
736
  </dd>
@@ -737,7 +754,7 @@ await client.windows.asyncSummarizeContent(
737
754
  <dl>
738
755
  <dd>
739
756
 
740
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
757
+ **windowId:** `string` — The Airtop window id of the browser window.
741
758
 
742
759
  </dd>
743
760
  </dl>
@@ -745,7 +762,7 @@ await client.windows.asyncSummarizeContent(
745
762
  <dl>
746
763
  <dd>
747
764
 
748
- **request:** `Airtop.AsyncSummarizeContentRequest`
765
+ **request:** `Airtop.SessionPageQueryHandlerRequestBody`
749
766
 
750
767
  </dd>
751
768
  </dl>
@@ -764,10 +781,25 @@ await client.windows.asyncSummarizeContent(
764
781
  </dl>
765
782
  </details>
766
783
 
767
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
784
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
785
+ <dl>
786
+ <dd>
787
+
788
+ #### 📝 Description
789
+
790
+ <dl>
791
+ <dd>
792
+
768
793
  <dl>
769
794
  <dd>
770
795
 
796
+ Scrape a window and return the content as markdown
797
+
798
+ </dd>
799
+ </dl>
800
+ </dd>
801
+ </dl>
802
+
771
803
  #### 🔌 Usage
772
804
 
773
805
  <dl>
@@ -777,9 +809,7 @@ await client.windows.asyncSummarizeContent(
777
809
  <dd>
778
810
 
779
811
  ```typescript
780
- await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
781
- text: "Example text",
782
- });
812
+ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
783
813
  ```
784
814
 
785
815
  </dd>
@@ -803,7 +833,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
803
833
  <dl>
804
834
  <dd>
805
835
 
806
- **windowId:** `string` — The Airtop window id of the browser window.
836
+ **windowId:** `string` — The Airtop window id of the browser window to scrape.
807
837
 
808
838
  </dd>
809
839
  </dl>
@@ -811,7 +841,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
811
841
  <dl>
812
842
  <dd>
813
843
 
814
- **request:** `Airtop.AsyncTypeRequest`
844
+ **request:** `Airtop.ScrapeContentRequest`
815
845
 
816
846
  </dd>
817
847
  </dl>
@@ -830,7 +860,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
830
860
  </dl>
831
861
  </details>
832
862
 
833
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
863
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
834
864
  <dl>
835
865
  <dd>
836
866
 
@@ -842,7 +872,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
842
872
  <dl>
843
873
  <dd>
844
874
 
845
- Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
875
+ Take a screenshot of a browser window
846
876
 
847
877
  </dd>
848
878
  </dl>
@@ -858,7 +888,7 @@ Creates a new browser window in a session. Optionally, you can specify a url to
858
888
  <dd>
859
889
 
860
890
  ```typescript
861
- await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
891
+ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
862
892
  ```
863
893
 
864
894
  </dd>
@@ -874,7 +904,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
874
904
  <dl>
875
905
  <dd>
876
906
 
877
- **sessionId:** `string` — ID of the session that owns the window.
907
+ **sessionId:** `string` — The session id for the window.
878
908
 
879
909
  </dd>
880
910
  </dl>
@@ -882,7 +912,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
882
912
  <dl>
883
913
  <dd>
884
914
 
885
- **request:** `Airtop.CreateWindowInputV1Body`
915
+ **windowId:** `string` — The Airtop window id of the browser window.
916
+
917
+ </dd>
918
+ </dl>
919
+
920
+ <dl>
921
+ <dd>
922
+
923
+ **request:** `Airtop.SessionScreenshotHandlerRequestBody`
886
924
 
887
925
  </dd>
888
926
  </dl>
@@ -901,7 +939,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
901
939
  </dl>
902
940
  </details>
903
941
 
904
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
942
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
905
943
  <dl>
906
944
  <dd>
907
945
 
@@ -913,7 +951,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
913
951
  <dl>
914
952
  <dd>
915
953
 
916
- Get information about a browser window in a session, including the live view url.
954
+ Execute a scroll interaction in a specific browser window
917
955
 
918
956
  </dd>
919
957
  </dl>
@@ -929,9 +967,7 @@ Get information about a browser window in a session, including the live view url
929
967
  <dd>
930
968
 
931
969
  ```typescript
932
- await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
933
- screenResolution: "1280x720",
934
- });
970
+ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
935
971
  ```
936
972
 
937
973
  </dd>
@@ -947,7 +983,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
947
983
  <dl>
948
984
  <dd>
949
985
 
950
- **sessionId:** `string` — ID of the session that owns the window.
986
+ **sessionId:** `string` — The session id for the window.
951
987
 
952
988
  </dd>
953
989
  </dl>
@@ -955,7 +991,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
955
991
  <dl>
956
992
  <dd>
957
993
 
958
- **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.
994
+ **windowId:** `string` — The Airtop window id of the browser window.
959
995
 
960
996
  </dd>
961
997
  </dl>
@@ -963,7 +999,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
963
999
  <dl>
964
1000
  <dd>
965
1001
 
966
- **request:** `Airtop.GetWindowInfoRequest`
1002
+ **request:** `Airtop.SessionScrollHandlerRequestBody`
967
1003
 
968
1004
  </dd>
969
1005
  </dl>
@@ -982,7 +1018,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
982
1018
  </dl>
983
1019
  </details>
984
1020
 
985
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
1021
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
986
1022
  <dl>
987
1023
  <dd>
988
1024
 
@@ -994,7 +1030,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
994
1030
  <dl>
995
1031
  <dd>
996
1032
 
997
- Loads a specified url on a given window
1033
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
998
1034
 
999
1035
  </dd>
1000
1036
  </dl>
@@ -1010,9 +1046,7 @@ Loads a specified url on a given window
1010
1046
  <dd>
1011
1047
 
1012
1048
  ```typescript
1013
- await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1014
- url: "https://www.airtop.ai",
1015
- });
1049
+ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1016
1050
  ```
1017
1051
 
1018
1052
  </dd>
@@ -1028,7 +1062,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1028
1062
  <dl>
1029
1063
  <dd>
1030
1064
 
1031
- **sessionId:** `string` — ID of the session that owns the window.
1065
+ **sessionId:** `string` — The session id for the window.
1032
1066
 
1033
1067
  </dd>
1034
1068
  </dl>
@@ -1036,7 +1070,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1036
1070
  <dl>
1037
1071
  <dd>
1038
1072
 
1039
- **windowId:** `string` — Airtop window ID of the browser window.
1073
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
1040
1074
 
1041
1075
  </dd>
1042
1076
  </dl>
@@ -1044,7 +1078,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1044
1078
  <dl>
1045
1079
  <dd>
1046
1080
 
1047
- **request:** `Airtop.WindowLoadUrlV1Body`
1081
+ **request:** `Airtop.SessionSummaryHandlerRequestBody`
1048
1082
 
1049
1083
  </dd>
1050
1084
  </dl>
@@ -1063,7 +1097,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1063
1097
  </dl>
1064
1098
  </details>
1065
1099
 
1066
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
1100
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1067
1101
  <dl>
1068
1102
  <dd>
1069
1103
 
@@ -1075,7 +1109,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
1075
1109
  <dl>
1076
1110
  <dd>
1077
1111
 
1078
- Closes a browser window in a session
1112
+ Execute a type interaction in a specific browser window
1079
1113
 
1080
1114
  </dd>
1081
1115
  </dl>
@@ -1091,7 +1125,9 @@ Closes a browser window in a session
1091
1125
  <dd>
1092
1126
 
1093
1127
  ```typescript
1094
- await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
1128
+ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1129
+ text: "Example text",
1130
+ });
1095
1131
  ```
1096
1132
 
1097
1133
  </dd>
@@ -1107,7 +1143,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1107
1143
  <dl>
1108
1144
  <dd>
1109
1145
 
1110
- **sessionId:** `string` — ID of the session that owns the window.
1146
+ **sessionId:** `string` — The session id for the window.
1111
1147
 
1112
1148
  </dd>
1113
1149
  </dl>
@@ -1115,7 +1151,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1115
1151
  <dl>
1116
1152
  <dd>
1117
1153
 
1118
- **windowId:** `string` — Airtop window ID of the browser window.
1154
+ **windowId:** `string` — The Airtop window id of the browser window.
1119
1155
 
1120
1156
  </dd>
1121
1157
  </dl>
@@ -1123,227 +1159,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
1123
1159
  <dl>
1124
1160
  <dd>
1125
1161
 
1126
- **requestOptions:** `Windows.RequestOptions`
1127
-
1128
- </dd>
1129
- </dl>
1130
- </dd>
1131
- </dl>
1132
-
1133
- </dd>
1134
- </dl>
1135
- </details>
1136
-
1137
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1138
- <dl>
1139
- <dd>
1140
-
1141
- #### 📝 Description
1142
-
1143
- <dl>
1144
- <dd>
1145
-
1146
- <dl>
1147
- <dd>
1148
-
1149
- Execute a click interaction in a specific browser window
1150
-
1151
- </dd>
1152
- </dl>
1153
- </dd>
1154
- </dl>
1155
-
1156
- #### 🔌 Usage
1157
-
1158
- <dl>
1159
- <dd>
1160
-
1161
- <dl>
1162
- <dd>
1163
-
1164
- ```typescript
1165
- await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1166
- elementDescription: "The login button",
1167
- });
1168
- ```
1169
-
1170
- </dd>
1171
- </dl>
1172
- </dd>
1173
- </dl>
1174
-
1175
- #### ⚙️ Parameters
1176
-
1177
- <dl>
1178
- <dd>
1179
-
1180
- <dl>
1181
- <dd>
1182
-
1183
- **sessionId:** `string` — The session id for the window.
1184
-
1185
- </dd>
1186
- </dl>
1187
-
1188
- <dl>
1189
- <dd>
1190
-
1191
- **windowId:** `string` — The Airtop window id of the browser window.
1192
-
1193
- </dd>
1194
- </dl>
1195
-
1196
- <dl>
1197
- <dd>
1198
-
1199
- **request:** `Airtop.SessionClickHandlerRequestBody`
1200
-
1201
- </dd>
1202
- </dl>
1203
-
1204
- <dl>
1205
- <dd>
1206
-
1207
- **requestOptions:** `Windows.RequestOptions`
1208
-
1209
- </dd>
1210
- </dl>
1211
- </dd>
1212
- </dl>
1213
-
1214
- </dd>
1215
- </dl>
1216
- </details>
1217
-
1218
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1219
- <dl>
1220
- <dd>
1221
-
1222
- #### 📝 Description
1223
-
1224
- <dl>
1225
- <dd>
1226
-
1227
- <dl>
1228
- <dd>
1229
-
1230
- Execute a hover interaction in a specific browser window
1231
-
1232
- </dd>
1233
- </dl>
1234
- </dd>
1235
- </dl>
1236
-
1237
- #### 🔌 Usage
1238
-
1239
- <dl>
1240
- <dd>
1241
-
1242
- <dl>
1243
- <dd>
1244
-
1245
- ```typescript
1246
- await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1247
- elementDescription: "The search box input in the top right corner",
1248
- });
1249
- ```
1250
-
1251
- </dd>
1252
- </dl>
1253
- </dd>
1254
- </dl>
1255
-
1256
- #### ⚙️ Parameters
1257
-
1258
- <dl>
1259
- <dd>
1260
-
1261
- <dl>
1262
- <dd>
1263
-
1264
- **sessionId:** `string` — The session id for the window.
1265
-
1266
- </dd>
1267
- </dl>
1268
-
1269
- <dl>
1270
- <dd>
1271
-
1272
- **windowId:** `string` — The Airtop window id of the browser window.
1273
-
1274
- </dd>
1275
- </dl>
1276
-
1277
- <dl>
1278
- <dd>
1279
-
1280
- **request:** `Airtop.SessionHoverHandlerRequestBody`
1281
-
1282
- </dd>
1283
- </dl>
1284
-
1285
- <dl>
1286
- <dd>
1287
-
1288
- **requestOptions:** `Windows.RequestOptions`
1289
-
1290
- </dd>
1291
- </dl>
1292
- </dd>
1293
- </dl>
1294
-
1295
- </dd>
1296
- </dl>
1297
- </details>
1298
-
1299
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1300
- <dl>
1301
- <dd>
1302
-
1303
- #### 🔌 Usage
1304
-
1305
- <dl>
1306
- <dd>
1307
-
1308
- <dl>
1309
- <dd>
1310
-
1311
- ```typescript
1312
- await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1313
- condition: "Determine if the user appears to be signed in to the website",
1314
- });
1315
- ```
1316
-
1317
- </dd>
1318
- </dl>
1319
- </dd>
1320
- </dl>
1321
-
1322
- #### ⚙️ Parameters
1323
-
1324
- <dl>
1325
- <dd>
1326
-
1327
- <dl>
1328
- <dd>
1329
-
1330
- **sessionId:** `string` — The session id for the window.
1331
-
1332
- </dd>
1333
- </dl>
1334
-
1335
- <dl>
1336
- <dd>
1337
-
1338
- **windowId:** `string` — The Airtop window id of the browser window.
1339
-
1340
- </dd>
1341
- </dl>
1342
-
1343
- <dl>
1344
- <dd>
1345
-
1346
- **request:** `Airtop.SessionMonitorHandlerRequestBody`
1162
+ **request:** `Airtop.SessionTypeHandlerRequestBody`
1347
1163
 
1348
1164
  </dd>
1349
1165
  </dl>
@@ -1362,965 +1178,6 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
1362
1178
  </dl>
1363
1179
  </details>
1364
1180
 
1365
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1366
- <dl>
1367
- <dd>
1368
-
1369
- #### 📝 Description
1370
-
1371
- <dl>
1372
- <dd>
1373
-
1374
- <dl>
1375
- <dd>
1376
-
1377
- 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?).
1378
-
1379
- </dd>
1380
- </dl>
1381
- </dd>
1382
- </dl>
1383
-
1384
- #### 🔌 Usage
1385
-
1386
- <dl>
1387
- <dd>
1388
-
1389
- <dl>
1390
- <dd>
1391
-
1392
- ```typescript
1393
- await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1394
- prompt: "What is the main idea of this page?",
1395
- });
1396
- ```
1397
-
1398
- </dd>
1399
- </dl>
1400
- </dd>
1401
- </dl>
1402
-
1403
- #### ⚙️ Parameters
1404
-
1405
- <dl>
1406
- <dd>
1407
-
1408
- <dl>
1409
- <dd>
1410
-
1411
- **sessionId:** `string` — The session id for the window.
1412
-
1413
- </dd>
1414
- </dl>
1415
-
1416
- <dl>
1417
- <dd>
1418
-
1419
- **windowId:** `string` — The Airtop window id of the browser window.
1420
-
1421
- </dd>
1422
- </dl>
1423
-
1424
- <dl>
1425
- <dd>
1426
-
1427
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1428
-
1429
- </dd>
1430
- </dl>
1431
-
1432
- <dl>
1433
- <dd>
1434
-
1435
- **requestOptions:** `Windows.RequestOptions`
1436
-
1437
- </dd>
1438
- </dl>
1439
- </dd>
1440
- </dl>
1441
-
1442
- </dd>
1443
- </dl>
1444
- </details>
1445
-
1446
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1447
- <dl>
1448
- <dd>
1449
-
1450
- #### 📝 Description
1451
-
1452
- <dl>
1453
- <dd>
1454
-
1455
- <dl>
1456
- <dd>
1457
-
1458
- Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
1459
-
1460
- </dd>
1461
- </dl>
1462
- </dd>
1463
- </dl>
1464
-
1465
- #### 🔌 Usage
1466
-
1467
- <dl>
1468
- <dd>
1469
-
1470
- <dl>
1471
- <dd>
1472
-
1473
- ```typescript
1474
- await client.windows.paginatedExtraction(
1475
- "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
1476
- "0334da2a-91b0-42c5-6156-76a5eba87430",
1477
- {
1478
- 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.",
1479
- }
1480
- );
1481
- ```
1482
-
1483
- </dd>
1484
- </dl>
1485
- </dd>
1486
- </dl>
1487
-
1488
- #### ⚙️ Parameters
1489
-
1490
- <dl>
1491
- <dd>
1492
-
1493
- <dl>
1494
- <dd>
1495
-
1496
- **sessionId:** `string` — The session id for the window.
1497
-
1498
- </dd>
1499
- </dl>
1500
-
1501
- <dl>
1502
- <dd>
1503
-
1504
- **windowId:** `string` — The Airtop window id of the browser window.
1505
-
1506
- </dd>
1507
- </dl>
1508
-
1509
- <dl>
1510
- <dd>
1511
-
1512
- **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
1513
-
1514
- </dd>
1515
- </dl>
1516
-
1517
- <dl>
1518
- <dd>
1519
-
1520
- **requestOptions:** `Windows.RequestOptions`
1521
-
1522
- </dd>
1523
- </dl>
1524
- </dd>
1525
- </dl>
1526
-
1527
- </dd>
1528
- </dl>
1529
- </details>
1530
-
1531
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1532
- <dl>
1533
- <dd>
1534
-
1535
- #### 📝 Description
1536
-
1537
- <dl>
1538
- <dd>
1539
-
1540
- <dl>
1541
- <dd>
1542
-
1543
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
1544
-
1545
- </dd>
1546
- </dl>
1547
- </dd>
1548
- </dl>
1549
-
1550
- #### 🔌 Usage
1551
-
1552
- <dl>
1553
- <dd>
1554
-
1555
- <dl>
1556
- <dd>
1557
-
1558
- ```typescript
1559
- await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1560
- prompt: "What is the main idea of this page?",
1561
- });
1562
- ```
1563
-
1564
- </dd>
1565
- </dl>
1566
- </dd>
1567
- </dl>
1568
-
1569
- #### ⚙️ Parameters
1570
-
1571
- <dl>
1572
- <dd>
1573
-
1574
- <dl>
1575
- <dd>
1576
-
1577
- **sessionId:** `string` — The session id for the window.
1578
-
1579
- </dd>
1580
- </dl>
1581
-
1582
- <dl>
1583
- <dd>
1584
-
1585
- **windowId:** `string` — The Airtop window id of the browser window.
1586
-
1587
- </dd>
1588
- </dl>
1589
-
1590
- <dl>
1591
- <dd>
1592
-
1593
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
1594
-
1595
- </dd>
1596
- </dl>
1597
-
1598
- <dl>
1599
- <dd>
1600
-
1601
- **requestOptions:** `Windows.RequestOptions`
1602
-
1603
- </dd>
1604
- </dl>
1605
- </dd>
1606
- </dl>
1607
-
1608
- </dd>
1609
- </dl>
1610
- </details>
1611
-
1612
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
1613
- <dl>
1614
- <dd>
1615
-
1616
- #### 📝 Description
1617
-
1618
- <dl>
1619
- <dd>
1620
-
1621
- <dl>
1622
- <dd>
1623
-
1624
- Scrape a window and return the content as markdown
1625
-
1626
- </dd>
1627
- </dl>
1628
- </dd>
1629
- </dl>
1630
-
1631
- #### 🔌 Usage
1632
-
1633
- <dl>
1634
- <dd>
1635
-
1636
- <dl>
1637
- <dd>
1638
-
1639
- ```typescript
1640
- await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1641
- ```
1642
-
1643
- </dd>
1644
- </dl>
1645
- </dd>
1646
- </dl>
1647
-
1648
- #### ⚙️ Parameters
1649
-
1650
- <dl>
1651
- <dd>
1652
-
1653
- <dl>
1654
- <dd>
1655
-
1656
- **sessionId:** `string` — The session id for the window.
1657
-
1658
- </dd>
1659
- </dl>
1660
-
1661
- <dl>
1662
- <dd>
1663
-
1664
- **windowId:** `string` — The Airtop window id of the browser window to scrape.
1665
-
1666
- </dd>
1667
- </dl>
1668
-
1669
- <dl>
1670
- <dd>
1671
-
1672
- **request:** `Airtop.ScrapeContentRequest`
1673
-
1674
- </dd>
1675
- </dl>
1676
-
1677
- <dl>
1678
- <dd>
1679
-
1680
- **requestOptions:** `Windows.RequestOptions`
1681
-
1682
- </dd>
1683
- </dl>
1684
- </dd>
1685
- </dl>
1686
-
1687
- </dd>
1688
- </dl>
1689
- </details>
1690
-
1691
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1692
- <dl>
1693
- <dd>
1694
-
1695
- #### 📝 Description
1696
-
1697
- <dl>
1698
- <dd>
1699
-
1700
- <dl>
1701
- <dd>
1702
-
1703
- Take a screenshot of a browser window
1704
-
1705
- </dd>
1706
- </dl>
1707
- </dd>
1708
- </dl>
1709
-
1710
- #### 🔌 Usage
1711
-
1712
- <dl>
1713
- <dd>
1714
-
1715
- <dl>
1716
- <dd>
1717
-
1718
- ```typescript
1719
- await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1720
- ```
1721
-
1722
- </dd>
1723
- </dl>
1724
- </dd>
1725
- </dl>
1726
-
1727
- #### ⚙️ Parameters
1728
-
1729
- <dl>
1730
- <dd>
1731
-
1732
- <dl>
1733
- <dd>
1734
-
1735
- **sessionId:** `string` — The session id for the window.
1736
-
1737
- </dd>
1738
- </dl>
1739
-
1740
- <dl>
1741
- <dd>
1742
-
1743
- **windowId:** `string` — The Airtop window id of the browser window.
1744
-
1745
- </dd>
1746
- </dl>
1747
-
1748
- <dl>
1749
- <dd>
1750
-
1751
- **request:** `Airtop.SessionScreenshotHandlerRequestBody`
1752
-
1753
- </dd>
1754
- </dl>
1755
-
1756
- <dl>
1757
- <dd>
1758
-
1759
- **requestOptions:** `Windows.RequestOptions`
1760
-
1761
- </dd>
1762
- </dl>
1763
- </dd>
1764
- </dl>
1765
-
1766
- </dd>
1767
- </dl>
1768
- </details>
1769
-
1770
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1771
- <dl>
1772
- <dd>
1773
-
1774
- #### 📝 Description
1775
-
1776
- <dl>
1777
- <dd>
1778
-
1779
- <dl>
1780
- <dd>
1781
-
1782
- Execute a scroll interaction in a specific browser window
1783
-
1784
- </dd>
1785
- </dl>
1786
- </dd>
1787
- </dl>
1788
-
1789
- #### 🔌 Usage
1790
-
1791
- <dl>
1792
- <dd>
1793
-
1794
- <dl>
1795
- <dd>
1796
-
1797
- ```typescript
1798
- await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1799
- ```
1800
-
1801
- </dd>
1802
- </dl>
1803
- </dd>
1804
- </dl>
1805
-
1806
- #### ⚙️ Parameters
1807
-
1808
- <dl>
1809
- <dd>
1810
-
1811
- <dl>
1812
- <dd>
1813
-
1814
- **sessionId:** `string` — The session id for the window.
1815
-
1816
- </dd>
1817
- </dl>
1818
-
1819
- <dl>
1820
- <dd>
1821
-
1822
- **windowId:** `string` — The Airtop window id of the browser window.
1823
-
1824
- </dd>
1825
- </dl>
1826
-
1827
- <dl>
1828
- <dd>
1829
-
1830
- **request:** `Airtop.SessionScrollHandlerRequestBody`
1831
-
1832
- </dd>
1833
- </dl>
1834
-
1835
- <dl>
1836
- <dd>
1837
-
1838
- **requestOptions:** `Windows.RequestOptions`
1839
-
1840
- </dd>
1841
- </dl>
1842
- </dd>
1843
- </dl>
1844
-
1845
- </dd>
1846
- </dl>
1847
- </details>
1848
-
1849
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1850
- <dl>
1851
- <dd>
1852
-
1853
- #### 📝 Description
1854
-
1855
- <dl>
1856
- <dd>
1857
-
1858
- <dl>
1859
- <dd>
1860
-
1861
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
1862
-
1863
- </dd>
1864
- </dl>
1865
- </dd>
1866
- </dl>
1867
-
1868
- #### 🔌 Usage
1869
-
1870
- <dl>
1871
- <dd>
1872
-
1873
- <dl>
1874
- <dd>
1875
-
1876
- ```typescript
1877
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1878
- ```
1879
-
1880
- </dd>
1881
- </dl>
1882
- </dd>
1883
- </dl>
1884
-
1885
- #### ⚙️ Parameters
1886
-
1887
- <dl>
1888
- <dd>
1889
-
1890
- <dl>
1891
- <dd>
1892
-
1893
- **sessionId:** `string` — The session id for the window.
1894
-
1895
- </dd>
1896
- </dl>
1897
-
1898
- <dl>
1899
- <dd>
1900
-
1901
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
1902
-
1903
- </dd>
1904
- </dl>
1905
-
1906
- <dl>
1907
- <dd>
1908
-
1909
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
1910
-
1911
- </dd>
1912
- </dl>
1913
-
1914
- <dl>
1915
- <dd>
1916
-
1917
- **requestOptions:** `Windows.RequestOptions`
1918
-
1919
- </dd>
1920
- </dl>
1921
- </dd>
1922
- </dl>
1923
-
1924
- </dd>
1925
- </dl>
1926
- </details>
1927
-
1928
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1929
- <dl>
1930
- <dd>
1931
-
1932
- #### 📝 Description
1933
-
1934
- <dl>
1935
- <dd>
1936
-
1937
- <dl>
1938
- <dd>
1939
-
1940
- Execute a type interaction in a specific browser window
1941
-
1942
- </dd>
1943
- </dl>
1944
- </dd>
1945
- </dl>
1946
-
1947
- #### 🔌 Usage
1948
-
1949
- <dl>
1950
- <dd>
1951
-
1952
- <dl>
1953
- <dd>
1954
-
1955
- ```typescript
1956
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1957
- text: "Example text",
1958
- });
1959
- ```
1960
-
1961
- </dd>
1962
- </dl>
1963
- </dd>
1964
- </dl>
1965
-
1966
- #### ⚙️ Parameters
1967
-
1968
- <dl>
1969
- <dd>
1970
-
1971
- <dl>
1972
- <dd>
1973
-
1974
- **sessionId:** `string` — The session id for the window.
1975
-
1976
- </dd>
1977
- </dl>
1978
-
1979
- <dl>
1980
- <dd>
1981
-
1982
- **windowId:** `string` — The Airtop window id of the browser window.
1983
-
1984
- </dd>
1985
- </dl>
1986
-
1987
- <dl>
1988
- <dd>
1989
-
1990
- **request:** `Airtop.SessionTypeHandlerRequestBody`
1991
-
1992
- </dd>
1993
- </dl>
1994
-
1995
- <dl>
1996
- <dd>
1997
-
1998
- **requestOptions:** `Windows.RequestOptions`
1999
-
2000
- </dd>
2001
- </dl>
2002
- </dd>
2003
- </dl>
2004
-
2005
- </dd>
2006
- </dl>
2007
- </details>
2008
-
2009
- ## Automations
2010
-
2011
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">listAutomations</a>() -> Airtop.ListAutomationsOutput</code></summary>
2012
- <dl>
2013
- <dd>
2014
-
2015
- #### 📝 Description
2016
-
2017
- <dl>
2018
- <dd>
2019
-
2020
- <dl>
2021
- <dd>
2022
-
2023
- List all automations for a given organization
2024
-
2025
- </dd>
2026
- </dl>
2027
- </dd>
2028
- </dl>
2029
-
2030
- #### 🔌 Usage
2031
-
2032
- <dl>
2033
- <dd>
2034
-
2035
- <dl>
2036
- <dd>
2037
-
2038
- ```typescript
2039
- await client.automations.listAutomations();
2040
- ```
2041
-
2042
- </dd>
2043
- </dl>
2044
- </dd>
2045
- </dl>
2046
-
2047
- #### ⚙️ Parameters
2048
-
2049
- <dl>
2050
- <dd>
2051
-
2052
- <dl>
2053
- <dd>
2054
-
2055
- **requestOptions:** `Automations.RequestOptions`
2056
-
2057
- </dd>
2058
- </dl>
2059
- </dd>
2060
- </dl>
2061
-
2062
- </dd>
2063
- </dl>
2064
- </details>
2065
-
2066
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">updateAutomationDescription</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
2067
- <dl>
2068
- <dd>
2069
-
2070
- #### 📝 Description
2071
-
2072
- <dl>
2073
- <dd>
2074
-
2075
- <dl>
2076
- <dd>
2077
-
2078
- Update the description of a specific automation
2079
-
2080
- </dd>
2081
- </dl>
2082
- </dd>
2083
- </dl>
2084
-
2085
- #### 🔌 Usage
2086
-
2087
- <dl>
2088
- <dd>
2089
-
2090
- <dl>
2091
- <dd>
2092
-
2093
- ```typescript
2094
- await client.automations.updateAutomationDescription({
2095
- description: "description",
2096
- id: "id",
2097
- orgId: "orgId",
2098
- });
2099
- ```
2100
-
2101
- </dd>
2102
- </dl>
2103
- </dd>
2104
- </dl>
2105
-
2106
- #### ⚙️ Parameters
2107
-
2108
- <dl>
2109
- <dd>
2110
-
2111
- <dl>
2112
- <dd>
2113
-
2114
- **request:** `Airtop.UpdateAutomationDescriptionInputBody`
2115
-
2116
- </dd>
2117
- </dl>
2118
-
2119
- <dl>
2120
- <dd>
2121
-
2122
- **requestOptions:** `Automations.RequestOptions`
2123
-
2124
- </dd>
2125
- </dl>
2126
- </dd>
2127
- </dl>
2128
-
2129
- </dd>
2130
- </dl>
2131
- </details>
2132
-
2133
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">getAutomation</a>(automationId) -> Airtop.AutomationOutput</code></summary>
2134
- <dl>
2135
- <dd>
2136
-
2137
- #### 📝 Description
2138
-
2139
- <dl>
2140
- <dd>
2141
-
2142
- <dl>
2143
- <dd>
2144
-
2145
- Get a specific automation by ID
2146
-
2147
- </dd>
2148
- </dl>
2149
- </dd>
2150
- </dl>
2151
-
2152
- #### 🔌 Usage
2153
-
2154
- <dl>
2155
- <dd>
2156
-
2157
- <dl>
2158
- <dd>
2159
-
2160
- ```typescript
2161
- await client.automations.getAutomation("automationId");
2162
- ```
2163
-
2164
- </dd>
2165
- </dl>
2166
- </dd>
2167
- </dl>
2168
-
2169
- #### ⚙️ Parameters
2170
-
2171
- <dl>
2172
- <dd>
2173
-
2174
- <dl>
2175
- <dd>
2176
-
2177
- **automationId:** `string` — ID of the automation to retrieve
2178
-
2179
- </dd>
2180
- </dl>
2181
-
2182
- <dl>
2183
- <dd>
2184
-
2185
- **requestOptions:** `Automations.RequestOptions`
2186
-
2187
- </dd>
2188
- </dl>
2189
- </dd>
2190
- </dl>
2191
-
2192
- </dd>
2193
- </dl>
2194
- </details>
2195
-
2196
- <details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">deleteAutomation</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
2197
- <dl>
2198
- <dd>
2199
-
2200
- #### 📝 Description
2201
-
2202
- <dl>
2203
- <dd>
2204
-
2205
- <dl>
2206
- <dd>
2207
-
2208
- Delete a specific automation
2209
-
2210
- </dd>
2211
- </dl>
2212
- </dd>
2213
- </dl>
2214
-
2215
- #### 🔌 Usage
2216
-
2217
- <dl>
2218
- <dd>
2219
-
2220
- <dl>
2221
- <dd>
2222
-
2223
- ```typescript
2224
- await client.automations.deleteAutomation("automationId");
2225
- ```
2226
-
2227
- </dd>
2228
- </dl>
2229
- </dd>
2230
- </dl>
2231
-
2232
- #### ⚙️ Parameters
2233
-
2234
- <dl>
2235
- <dd>
2236
-
2237
- <dl>
2238
- <dd>
2239
-
2240
- **automationId:** `string` — ID of the automation to delete
2241
-
2242
- </dd>
2243
- </dl>
2244
-
2245
- <dl>
2246
- <dd>
2247
-
2248
- **requestOptions:** `Automations.RequestOptions`
2249
-
2250
- </dd>
2251
- </dl>
2252
- </dd>
2253
- </dl>
2254
-
2255
- </dd>
2256
- </dl>
2257
- </details>
2258
-
2259
- ## ExtensionConfigurations
2260
-
2261
- <details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationGetInfo</a>(name) -> Airtop.ExtensionConfigurationOutput</code></summary>
2262
- <dl>
2263
- <dd>
2264
-
2265
- #### 📝 Description
2266
-
2267
- <dl>
2268
- <dd>
2269
-
2270
- <dl>
2271
- <dd>
2272
-
2273
- Get an extension configuration by name
2274
-
2275
- </dd>
2276
- </dl>
2277
- </dd>
2278
- </dl>
2279
-
2280
- #### 🔌 Usage
2281
-
2282
- <dl>
2283
- <dd>
2284
-
2285
- <dl>
2286
- <dd>
2287
-
2288
- ```typescript
2289
- await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration");
2290
- ```
2291
-
2292
- </dd>
2293
- </dl>
2294
- </dd>
2295
- </dl>
2296
-
2297
- #### ⚙️ Parameters
2298
-
2299
- <dl>
2300
- <dd>
2301
-
2302
- <dl>
2303
- <dd>
2304
-
2305
- **name:** `string` — Name of the extension configuration to get
2306
-
2307
- </dd>
2308
- </dl>
2309
-
2310
- <dl>
2311
- <dd>
2312
-
2313
- **requestOptions:** `ExtensionConfigurations.RequestOptions`
2314
-
2315
- </dd>
2316
- </dl>
2317
- </dd>
2318
- </dl>
2319
-
2320
- </dd>
2321
- </dl>
2322
- </details>
2323
-
2324
1181
  ## Profiles
2325
1182
 
2326
1183
  <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>