@airtop/sdk 0.1.31 → 0.1.33-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 (279) hide show
  1. package/Client.d.ts +6 -0
  2. package/Client.js +16 -6
  3. package/README.md +8 -6
  4. package/api/errors/ForbiddenError.d.ts +8 -0
  5. package/api/errors/ForbiddenError.js +41 -0
  6. package/api/errors/UnauthorizedError.d.ts +8 -0
  7. package/api/errors/UnauthorizedError.js +41 -0
  8. package/api/errors/index.d.ts +2 -0
  9. package/api/errors/index.js +2 -0
  10. package/api/resources/automations/client/Client.d.ts +87 -0
  11. package/api/resources/automations/client/Client.js +451 -0
  12. package/api/resources/automations/client/index.d.ts +1 -0
  13. package/api/resources/automations/client/index.js +17 -0
  14. package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +19 -0
  15. package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +5 -0
  16. package/api/resources/automations/client/requests/index.d.ts +1 -0
  17. package/api/resources/automations/client/requests/index.js +2 -0
  18. package/api/resources/automations/index.d.ts +1 -0
  19. package/api/resources/automations/index.js +17 -0
  20. package/api/resources/extensionConfigurations/client/Client.d.ts +40 -0
  21. package/api/resources/extensionConfigurations/client/Client.js +149 -0
  22. package/api/resources/extensionConfigurations/client/index.d.ts +1 -0
  23. package/api/resources/extensionConfigurations/client/index.js +2 -0
  24. package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +13 -0
  25. package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +5 -0
  26. package/api/resources/extensionConfigurations/client/requests/index.d.ts +1 -0
  27. package/api/resources/extensionConfigurations/client/requests/index.js +2 -0
  28. package/api/resources/extensionConfigurations/index.d.ts +1 -0
  29. package/api/resources/extensionConfigurations/index.js +17 -0
  30. package/api/resources/index.d.ts +3 -0
  31. package/api/resources/index.js +4 -1
  32. package/api/resources/profiles/client/Client.js +2 -2
  33. package/api/resources/requests/client/Client.js +2 -2
  34. package/api/resources/sessions/client/Client.d.ts +9 -0
  35. package/api/resources/sessions/client/Client.js +65 -12
  36. package/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
  37. package/api/resources/sessions/types/index.d.ts +1 -1
  38. package/api/resources/sessions/types/index.js +1 -1
  39. package/api/resources/windows/client/Client.d.ts +138 -0
  40. package/api/resources/windows/client/Client.js +729 -30
  41. package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
  42. package/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
  43. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
  44. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
  45. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
  46. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
  47. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
  48. package/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
  49. package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
  50. package/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
  51. package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
  52. package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
  53. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
  54. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
  55. package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
  56. package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
  57. package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
  58. package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
  59. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
  60. package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
  61. package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
  62. package/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
  63. package/api/resources/windows/client/requests/index.d.ts +11 -0
  64. package/api/types/AsyncConfig.d.ts +7 -0
  65. package/api/types/AsyncConfig.js +5 -0
  66. package/api/types/AsyncSessionAiResponseEnvelope.d.ts +9 -0
  67. package/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
  68. package/api/types/AutomationOutput.d.ts +10 -0
  69. package/api/types/AutomationOutput.js +5 -0
  70. package/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
  71. package/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
  72. package/api/types/DeleteAutomationOutputWrapperBody.d.ts +4 -0
  73. package/api/types/DeleteAutomationOutputWrapperBody.js +5 -0
  74. package/api/types/ExtensionConfigurationOutput.d.ts +13 -0
  75. package/api/types/ExtensionConfigurationOutput.js +5 -0
  76. package/api/types/ListAutomationsOutput.d.ts +7 -0
  77. package/api/types/ListAutomationsOutput.js +5 -0
  78. package/api/types/SessionConfigV1.d.ts +2 -0
  79. package/api/types/index.d.ts +7 -0
  80. package/api/types/index.js +7 -0
  81. package/dist/Client.d.ts +6 -0
  82. package/dist/Client.js +16 -6
  83. package/dist/api/errors/ForbiddenError.d.ts +8 -0
  84. package/dist/api/errors/ForbiddenError.js +41 -0
  85. package/dist/api/errors/UnauthorizedError.d.ts +8 -0
  86. package/dist/api/errors/UnauthorizedError.js +41 -0
  87. package/dist/api/errors/index.d.ts +2 -0
  88. package/dist/api/errors/index.js +2 -0
  89. package/dist/api/resources/automations/client/Client.d.ts +87 -0
  90. package/dist/api/resources/automations/client/Client.js +451 -0
  91. package/dist/api/resources/automations/client/index.d.ts +1 -0
  92. package/dist/api/resources/automations/client/index.js +17 -0
  93. package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +19 -0
  94. package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +5 -0
  95. package/dist/api/resources/automations/client/requests/index.d.ts +1 -0
  96. package/dist/api/resources/automations/client/requests/index.js +2 -0
  97. package/dist/api/resources/automations/index.d.ts +1 -0
  98. package/dist/api/resources/automations/index.js +17 -0
  99. package/dist/api/resources/extensionConfigurations/client/Client.d.ts +40 -0
  100. package/dist/api/resources/extensionConfigurations/client/Client.js +149 -0
  101. package/dist/api/resources/extensionConfigurations/client/index.d.ts +1 -0
  102. package/dist/api/resources/extensionConfigurations/client/index.js +2 -0
  103. package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +13 -0
  104. package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +5 -0
  105. package/dist/api/resources/extensionConfigurations/client/requests/index.d.ts +1 -0
  106. package/dist/api/resources/extensionConfigurations/client/requests/index.js +2 -0
  107. package/dist/api/resources/extensionConfigurations/index.d.ts +1 -0
  108. package/dist/api/resources/extensionConfigurations/index.js +17 -0
  109. package/dist/api/resources/index.d.ts +3 -0
  110. package/dist/api/resources/index.js +4 -1
  111. package/dist/api/resources/profiles/client/Client.js +2 -2
  112. package/dist/api/resources/requests/client/Client.js +2 -2
  113. package/dist/api/resources/sessions/client/Client.d.ts +9 -0
  114. package/dist/api/resources/sessions/client/Client.js +65 -12
  115. package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
  116. package/dist/api/resources/sessions/types/index.d.ts +1 -1
  117. package/dist/api/resources/sessions/types/index.js +1 -1
  118. package/dist/api/resources/windows/client/Client.d.ts +138 -0
  119. package/dist/api/resources/windows/client/Client.js +729 -30
  120. package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
  121. package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
  122. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
  123. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
  124. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
  125. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
  126. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
  127. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
  128. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
  129. package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
  130. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
  131. package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
  132. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
  133. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
  134. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
  135. package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
  136. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
  137. package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
  138. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
  139. package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
  140. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
  141. package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
  142. package/dist/api/resources/windows/client/requests/index.d.ts +11 -0
  143. package/dist/api/types/AsyncConfig.d.ts +7 -0
  144. package/dist/api/types/AsyncConfig.js +5 -0
  145. package/dist/api/types/AsyncSessionAiResponseEnvelope.d.ts +9 -0
  146. package/dist/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
  147. package/dist/api/types/AutomationOutput.d.ts +10 -0
  148. package/dist/api/types/AutomationOutput.js +5 -0
  149. package/dist/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
  150. package/dist/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
  151. package/dist/api/types/DeleteAutomationOutputWrapperBody.d.ts +4 -0
  152. package/dist/api/types/DeleteAutomationOutputWrapperBody.js +5 -0
  153. package/dist/api/types/ExtensionConfigurationOutput.d.ts +13 -0
  154. package/dist/api/types/ExtensionConfigurationOutput.js +5 -0
  155. package/dist/api/types/ListAutomationsOutput.d.ts +7 -0
  156. package/dist/api/types/ListAutomationsOutput.js +5 -0
  157. package/dist/api/types/SessionConfigV1.d.ts +2 -0
  158. package/dist/api/types/index.d.ts +7 -0
  159. package/dist/api/types/index.js +7 -0
  160. package/dist/serialization/resources/automations/client/index.d.ts +1 -0
  161. package/dist/serialization/resources/automations/client/index.js +17 -0
  162. package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +14 -0
  163. package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +35 -0
  164. package/dist/serialization/resources/automations/client/requests/index.d.ts +1 -0
  165. package/dist/serialization/resources/automations/client/requests/index.js +5 -0
  166. package/dist/serialization/resources/automations/index.d.ts +1 -0
  167. package/dist/serialization/resources/automations/index.js +17 -0
  168. package/dist/serialization/resources/index.d.ts +2 -0
  169. package/dist/serialization/resources/index.js +3 -1
  170. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
  171. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
  172. package/dist/serialization/resources/sessions/types/index.d.ts +1 -1
  173. package/dist/serialization/resources/sessions/types/index.js +1 -1
  174. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
  175. package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
  176. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
  177. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
  178. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
  179. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
  180. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
  181. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
  182. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
  183. package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +40 -0
  184. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
  185. package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
  186. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
  187. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
  188. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
  189. package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
  190. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
  191. package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
  192. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
  193. package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
  194. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
  195. package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
  196. package/dist/serialization/resources/windows/client/requests/index.d.ts +11 -0
  197. package/dist/serialization/resources/windows/client/requests/index.js +23 -1
  198. package/dist/serialization/types/AsyncConfig.d.ts +12 -0
  199. package/dist/serialization/types/AsyncConfig.js +33 -0
  200. package/dist/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
  201. package/dist/serialization/types/AsyncSessionAiResponseEnvelope.js +36 -0
  202. package/dist/serialization/types/AutomationOutput.d.ts +16 -0
  203. package/dist/serialization/types/AutomationOutput.js +37 -0
  204. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
  205. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
  206. package/dist/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +10 -0
  207. package/dist/serialization/types/DeleteAutomationOutputWrapperBody.js +31 -0
  208. package/dist/serialization/types/ExtensionConfigurationOutput.d.ts +15 -0
  209. package/dist/serialization/types/ExtensionConfigurationOutput.js +36 -0
  210. package/dist/serialization/types/ListAutomationsOutput.d.ts +13 -0
  211. package/dist/serialization/types/ListAutomationsOutput.js +34 -0
  212. package/dist/serialization/types/SessionConfigV1.d.ts +1 -0
  213. package/dist/serialization/types/SessionConfigV1.js +1 -0
  214. package/dist/serialization/types/index.d.ts +7 -0
  215. package/dist/serialization/types/index.js +7 -0
  216. package/dist/wrapper/AirtopClient.d.ts +1 -0
  217. package/dist/wrapper/AirtopClient.js +3 -0
  218. package/dist/wrapper/AirtopWindows.d.ts +1 -1
  219. package/package.json +3 -2
  220. package/reference.md +1299 -156
  221. package/serialization/resources/automations/client/index.d.ts +1 -0
  222. package/serialization/resources/automations/client/index.js +17 -0
  223. package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +14 -0
  224. package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +35 -0
  225. package/serialization/resources/automations/client/requests/index.d.ts +1 -0
  226. package/serialization/resources/automations/client/requests/index.js +5 -0
  227. package/serialization/resources/automations/index.d.ts +1 -0
  228. package/serialization/resources/automations/index.js +17 -0
  229. package/serialization/resources/index.d.ts +2 -0
  230. package/serialization/resources/index.js +3 -1
  231. package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
  232. package/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
  233. package/serialization/resources/sessions/types/index.d.ts +1 -1
  234. package/serialization/resources/sessions/types/index.js +1 -1
  235. package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
  236. package/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
  237. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
  238. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
  239. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
  240. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
  241. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
  242. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
  243. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
  244. package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +40 -0
  245. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
  246. package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
  247. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
  248. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
  249. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
  250. package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
  251. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
  252. package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
  253. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
  254. package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
  255. package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
  256. package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
  257. package/serialization/resources/windows/client/requests/index.d.ts +11 -0
  258. package/serialization/resources/windows/client/requests/index.js +23 -1
  259. package/serialization/types/AsyncConfig.d.ts +12 -0
  260. package/serialization/types/AsyncConfig.js +33 -0
  261. package/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
  262. package/serialization/types/AsyncSessionAiResponseEnvelope.js +36 -0
  263. package/serialization/types/AutomationOutput.d.ts +16 -0
  264. package/serialization/types/AutomationOutput.js +37 -0
  265. package/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
  266. package/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
  267. package/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +10 -0
  268. package/serialization/types/DeleteAutomationOutputWrapperBody.js +31 -0
  269. package/serialization/types/ExtensionConfigurationOutput.d.ts +15 -0
  270. package/serialization/types/ExtensionConfigurationOutput.js +36 -0
  271. package/serialization/types/ListAutomationsOutput.d.ts +13 -0
  272. package/serialization/types/ListAutomationsOutput.js +34 -0
  273. package/serialization/types/SessionConfigV1.d.ts +1 -0
  274. package/serialization/types/SessionConfigV1.js +1 -0
  275. package/serialization/types/index.d.ts +7 -0
  276. package/serialization/types/index.js +7 -0
  277. package/wrapper/AirtopClient.d.ts +1 -0
  278. package/wrapper/AirtopClient.js +3 -0
  279. package/wrapper/AirtopWindows.d.ts +1 -1
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">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
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
6
  <dl>
7
7
  <dd>
8
8
 
@@ -14,7 +14,7 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
17
+ Execute a click interaction in a specific browser window asynchronously
18
18
 
19
19
  </dd>
20
20
  </dl>
@@ -30,7 +30,9 @@ Creates a new browser window in a session. Optionally, you can specify a url to
30
30
  <dd>
31
31
 
32
32
  ```typescript
33
- await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
33
+ await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
34
+ elementDescription: "The login button",
35
+ });
34
36
  ```
35
37
 
36
38
  </dd>
@@ -46,7 +48,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
46
48
  <dl>
47
49
  <dd>
48
50
 
49
- **sessionId:** `string` — ID of the session that owns the window.
51
+ **sessionId:** `string` — The session id for the window.
50
52
 
51
53
  </dd>
52
54
  </dl>
@@ -54,7 +56,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
54
56
  <dl>
55
57
  <dd>
56
58
 
57
- **request:** `Airtop.CreateWindowInputV1Body`
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`
58
68
 
59
69
  </dd>
60
70
  </dl>
@@ -73,7 +83,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
73
83
  </dl>
74
84
  </details>
75
85
 
76
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
86
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
77
87
  <dl>
78
88
  <dd>
79
89
 
@@ -85,7 +95,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
85
95
  <dl>
86
96
  <dd>
87
97
 
88
- Get information about a browser window in a session, including the live view url.
98
+ Create an automation of a browser window asynchronously
89
99
 
90
100
  </dd>
91
101
  </dl>
@@ -101,9 +111,10 @@ Get information about a browser window in a session, including the live view url
101
111
  <dd>
102
112
 
103
113
  ```typescript
104
- await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
105
- screenResolution: "1280x720",
106
- });
114
+ await client.windows.asyncCreateAutomation(
115
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
116
+ "0334da2a-91b0-42c5-6156-76a5eba87430"
117
+ );
107
118
  ```
108
119
 
109
120
  </dd>
@@ -119,7 +130,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
119
130
  <dl>
120
131
  <dd>
121
132
 
122
- **sessionId:** `string` — ID of the session that owns the window.
133
+ **sessionId:** `string` — The session id for the window.
123
134
 
124
135
  </dd>
125
136
  </dl>
@@ -127,7 +138,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
127
138
  <dl>
128
139
  <dd>
129
140
 
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.
141
+ **windowId:** `string` — The Airtop window id of the browser window.
131
142
 
132
143
  </dd>
133
144
  </dl>
@@ -135,7 +146,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
135
146
  <dl>
136
147
  <dd>
137
148
 
138
- **request:** `Airtop.GetWindowInfoRequest`
149
+ **request:** `Airtop.AsyncCreateAutomationRequest`
139
150
 
140
151
  </dd>
141
152
  </dl>
@@ -154,7 +165,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
154
165
  </dl>
155
166
  </details>
156
167
 
157
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
168
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
158
169
  <dl>
159
170
  <dd>
160
171
 
@@ -166,7 +177,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
166
177
  <dl>
167
178
  <dd>
168
179
 
169
- Loads a specified url on a given window
180
+ Execute an automation of a browser window asynchronously
170
181
 
171
182
  </dd>
172
183
  </dl>
@@ -182,9 +193,13 @@ Loads a specified url on a given window
182
193
  <dd>
183
194
 
184
195
  ```typescript
185
- await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
186
- url: "https://www.airtop.ai",
187
- });
196
+ await client.windows.asyncExecuteAutomation(
197
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
198
+ "0334da2a-91b0-42c5-6156-76a5eba87430",
199
+ {
200
+ automationId: "automationId",
201
+ }
202
+ );
188
203
  ```
189
204
 
190
205
  </dd>
@@ -200,7 +215,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
200
215
  <dl>
201
216
  <dd>
202
217
 
203
- **sessionId:** `string` — ID of the session that owns the window.
218
+ **sessionId:** `string` — The session id for the window.
204
219
 
205
220
  </dd>
206
221
  </dl>
@@ -208,7 +223,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
208
223
  <dl>
209
224
  <dd>
210
225
 
211
- **windowId:** `string` — Airtop window ID of the browser window.
226
+ **windowId:** `string` — The Airtop window id of the browser window.
212
227
 
213
228
  </dd>
214
229
  </dl>
@@ -216,7 +231,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
216
231
  <dl>
217
232
  <dd>
218
233
 
219
- **request:** `Airtop.WindowLoadUrlV1Body`
234
+ **request:** `Airtop.AsyncExecuteAutomationRequest`
220
235
 
221
236
  </dd>
222
237
  </dl>
@@ -235,11 +250,11 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
235
250
  </dl>
236
251
  </details>
237
252
 
238
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
253
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
239
254
  <dl>
240
255
  <dd>
241
256
 
242
- #### 📝 Description
257
+ #### 🔌 Usage
243
258
 
244
259
  <dl>
245
260
  <dd>
@@ -247,14 +262,18 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
247
262
  <dl>
248
263
  <dd>
249
264
 
250
- Closes a browser window in a session
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
+ ```
251
270
 
252
271
  </dd>
253
272
  </dl>
254
273
  </dd>
255
274
  </dl>
256
275
 
257
- #### 🔌 Usage
276
+ #### ⚙️ Parameters
258
277
 
259
278
  <dl>
260
279
  <dd>
@@ -262,24 +281,15 @@ Closes a browser window in a session
262
281
  <dl>
263
282
  <dd>
264
283
 
265
- ```typescript
266
- await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
267
- ```
284
+ **sessionId:** `string` — The session id for the window.
268
285
 
269
286
  </dd>
270
287
  </dl>
271
- </dd>
272
- </dl>
273
-
274
- #### ⚙️ Parameters
275
-
276
- <dl>
277
- <dd>
278
288
 
279
289
  <dl>
280
290
  <dd>
281
291
 
282
- **sessionId:** `string` — ID of the session that owns the window.
292
+ **windowId:** `string` — The Airtop window id of the browser window.
283
293
 
284
294
  </dd>
285
295
  </dl>
@@ -287,7 +297,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
287
297
  <dl>
288
298
  <dd>
289
299
 
290
- **windowId:** `string` — Airtop window ID of the browser window.
300
+ **request:** `Airtop.AsyncHoverRequest`
291
301
 
292
302
  </dd>
293
303
  </dl>
@@ -306,25 +316,10 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
306
316
  </dl>
307
317
  </details>
308
318
 
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
-
319
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
318
320
  <dl>
319
321
  <dd>
320
322
 
321
- Execute a click interaction in a specific browser window
322
-
323
- </dd>
324
- </dl>
325
- </dd>
326
- </dl>
327
-
328
323
  #### 🔌 Usage
329
324
 
330
325
  <dl>
@@ -334,8 +329,8 @@ Execute a click interaction in a specific browser window
334
329
  <dd>
335
330
 
336
331
  ```typescript
337
- await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
338
- elementDescription: "The login button",
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",
339
334
  });
340
335
  ```
341
336
 
@@ -368,7 +363,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
368
363
  <dl>
369
364
  <dd>
370
365
 
371
- **request:** `Airtop.SessionClickHandlerRequestBody`
366
+ **request:** `Airtop.AsyncMonitorRequest`
372
367
 
373
368
  </dd>
374
369
  </dl>
@@ -387,25 +382,10 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
387
382
  </dl>
388
383
  </details>
389
384
 
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
-
385
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
399
386
  <dl>
400
387
  <dd>
401
388
 
402
- Execute a hover interaction in a specific browser window
403
-
404
- </dd>
405
- </dl>
406
- </dd>
407
- </dl>
408
-
409
389
  #### 🔌 Usage
410
390
 
411
391
  <dl>
@@ -415,8 +395,8 @@ Execute a hover interaction in a specific browser window
415
395
  <dd>
416
396
 
417
397
  ```typescript
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",
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?",
420
400
  });
421
401
  ```
422
402
 
@@ -449,7 +429,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
449
429
  <dl>
450
430
  <dd>
451
431
 
452
- **request:** `Airtop.SessionHoverHandlerRequestBody`
432
+ **request:** `Airtop.AsyncPageQueryRequest`
453
433
 
454
434
  </dd>
455
435
  </dl>
@@ -468,7 +448,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
468
448
  </dl>
469
449
  </details>
470
450
 
471
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
451
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
472
452
  <dl>
473
453
  <dd>
474
454
 
@@ -481,9 +461,13 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
481
461
  <dd>
482
462
 
483
463
  ```typescript
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
- });
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
+ );
487
471
  ```
488
472
 
489
473
  </dd>
@@ -515,7 +499,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
515
499
  <dl>
516
500
  <dd>
517
501
 
518
- **request:** `Airtop.SessionMonitorHandlerRequestBody`
502
+ **request:** `Airtop.AsyncPaginatedExtractionRequest`
519
503
 
520
504
  </dd>
521
505
  </dl>
@@ -534,7 +518,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
534
518
  </dl>
535
519
  </details>
536
520
 
537
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
521
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
538
522
  <dl>
539
523
  <dd>
540
524
 
@@ -546,7 +530,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
546
530
  <dl>
547
531
  <dd>
548
532
 
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?).
533
+ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
550
534
 
551
535
  </dd>
552
536
  </dl>
@@ -562,9 +546,13 @@ Submit a prompt that queries the content of a specific browser window. You may e
562
546
  <dd>
563
547
 
564
548
  ```typescript
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
- });
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
+ );
568
556
  ```
569
557
 
570
558
  </dd>
@@ -596,7 +584,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
596
584
  <dl>
597
585
  <dd>
598
586
 
599
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
587
+ **request:** `Airtop.AsyncPromptContentRequest`
600
588
 
601
589
  </dd>
602
590
  </dl>
@@ -615,7 +603,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
615
603
  </dl>
616
604
  </details>
617
605
 
618
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
606
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
619
607
  <dl>
620
608
  <dd>
621
609
 
@@ -627,7 +615,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
627
615
  <dl>
628
616
  <dd>
629
617
 
630
- Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
618
+ Take a screenshot of the current viewport of a browser window asynchronously
631
619
 
632
620
  </dd>
633
621
  </dl>
@@ -643,13 +631,7 @@ Submit a prompt that queries the content of a specific browser window and pagina
643
631
  <dd>
644
632
 
645
633
  ```typescript
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
- );
634
+ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
653
635
  ```
654
636
 
655
637
  </dd>
@@ -681,7 +663,7 @@ await client.windows.paginatedExtraction(
681
663
  <dl>
682
664
  <dd>
683
665
 
684
- **request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
666
+ **request:** `Airtop.AsyncScreenshotRequest`
685
667
 
686
668
  </dd>
687
669
  </dl>
@@ -700,7 +682,7 @@ await client.windows.paginatedExtraction(
700
682
  </dl>
701
683
  </details>
702
684
 
703
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
685
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
704
686
  <dl>
705
687
  <dd>
706
688
 
@@ -712,7 +694,7 @@ await client.windows.paginatedExtraction(
712
694
  <dl>
713
695
  <dd>
714
696
 
715
- This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
697
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
716
698
 
717
699
  </dd>
718
700
  </dl>
@@ -728,9 +710,10 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
728
710
  <dd>
729
711
 
730
712
  ```typescript
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
- });
713
+ await client.windows.asyncSummarizeContent(
714
+ "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
715
+ "0334da2a-91b0-42c5-6156-76a5eba87430"
716
+ );
734
717
  ```
735
718
 
736
719
  </dd>
@@ -754,7 +737,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
754
737
  <dl>
755
738
  <dd>
756
739
 
757
- **windowId:** `string` — The Airtop window id of the browser window.
740
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
758
741
 
759
742
  </dd>
760
743
  </dl>
@@ -762,7 +745,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
762
745
  <dl>
763
746
  <dd>
764
747
 
765
- **request:** `Airtop.SessionPageQueryHandlerRequestBody`
748
+ **request:** `Airtop.AsyncSummarizeContentRequest`
766
749
 
767
750
  </dd>
768
751
  </dl>
@@ -781,25 +764,10 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
781
764
  </dl>
782
765
  </details>
783
766
 
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
-
767
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
793
768
  <dl>
794
769
  <dd>
795
770
 
796
- Scrape a window and return the content as markdown
797
-
798
- </dd>
799
- </dl>
800
- </dd>
801
- </dl>
802
-
803
771
  #### 🔌 Usage
804
772
 
805
773
  <dl>
@@ -809,7 +777,9 @@ Scrape a window and return the content as markdown
809
777
  <dd>
810
778
 
811
779
  ```typescript
812
- await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
780
+ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
781
+ text: "Example text",
782
+ });
813
783
  ```
814
784
 
815
785
  </dd>
@@ -833,7 +803,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
833
803
  <dl>
834
804
  <dd>
835
805
 
836
- **windowId:** `string` — The Airtop window id of the browser window to scrape.
806
+ **windowId:** `string` — The Airtop window id of the browser window.
837
807
 
838
808
  </dd>
839
809
  </dl>
@@ -841,7 +811,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
841
811
  <dl>
842
812
  <dd>
843
813
 
844
- **request:** `Airtop.ScrapeContentRequest`
814
+ **request:** `Airtop.AsyncTypeRequest`
845
815
 
846
816
  </dd>
847
817
  </dl>
@@ -860,7 +830,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
860
830
  </dl>
861
831
  </details>
862
832
 
863
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
833
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
864
834
  <dl>
865
835
  <dd>
866
836
 
@@ -872,7 +842,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
872
842
  <dl>
873
843
  <dd>
874
844
 
875
- Take a screenshot of a browser window
845
+ Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
876
846
 
877
847
  </dd>
878
848
  </dl>
@@ -888,7 +858,7 @@ Take a screenshot of a browser window
888
858
  <dd>
889
859
 
890
860
  ```typescript
891
- await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
861
+ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
892
862
  ```
893
863
 
894
864
  </dd>
@@ -904,15 +874,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
904
874
  <dl>
905
875
  <dd>
906
876
 
907
- **sessionId:** `string` — The session id for the window.
908
-
909
- </dd>
910
- </dl>
911
-
912
- <dl>
913
- <dd>
914
-
915
- **windowId:** `string` — The Airtop window id of the browser window.
877
+ **sessionId:** `string` — ID of the session that owns the window.
916
878
 
917
879
  </dd>
918
880
  </dl>
@@ -920,7 +882,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
920
882
  <dl>
921
883
  <dd>
922
884
 
923
- **request:** `Airtop.SessionScreenshotHandlerRequestBody`
885
+ **request:** `Airtop.CreateWindowInputV1Body`
924
886
 
925
887
  </dd>
926
888
  </dl>
@@ -939,7 +901,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
939
901
  </dl>
940
902
  </details>
941
903
 
942
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
904
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
943
905
  <dl>
944
906
  <dd>
945
907
 
@@ -951,7 +913,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
951
913
  <dl>
952
914
  <dd>
953
915
 
954
- Execute a scroll interaction in a specific browser window
916
+ Get information about a browser window in a session, including the live view url.
955
917
 
956
918
  </dd>
957
919
  </dl>
@@ -967,7 +929,9 @@ Execute a scroll interaction in a specific browser window
967
929
  <dd>
968
930
 
969
931
  ```typescript
970
- await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
932
+ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
933
+ screenResolution: "1280x720",
934
+ });
971
935
  ```
972
936
 
973
937
  </dd>
@@ -983,7 +947,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
983
947
  <dl>
984
948
  <dd>
985
949
 
986
- **sessionId:** `string` — The session id for the window.
950
+ **sessionId:** `string` — ID of the session that owns the window.
987
951
 
988
952
  </dd>
989
953
  </dl>
@@ -991,7 +955,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
991
955
  <dl>
992
956
  <dd>
993
957
 
994
- **windowId:** `string` — The Airtop window id of the browser window.
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.
995
959
 
996
960
  </dd>
997
961
  </dl>
@@ -999,7 +963,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
999
963
  <dl>
1000
964
  <dd>
1001
965
 
1002
- **request:** `Airtop.SessionScrollHandlerRequestBody`
966
+ **request:** `Airtop.GetWindowInfoRequest`
1003
967
 
1004
968
  </dd>
1005
969
  </dl>
@@ -1018,7 +982,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1018
982
  </dl>
1019
983
  </details>
1020
984
 
1021
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
985
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
1022
986
  <dl>
1023
987
  <dd>
1024
988
 
@@ -1030,7 +994,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
1030
994
  <dl>
1031
995
  <dd>
1032
996
 
1033
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
997
+ Loads a specified url on a given window
1034
998
 
1035
999
  </dd>
1036
1000
  </dl>
@@ -1046,7 +1010,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
1046
1010
  <dd>
1047
1011
 
1048
1012
  ```typescript
1049
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
1013
+ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
1014
+ url: "https://www.airtop.ai",
1015
+ });
1050
1016
  ```
1051
1017
 
1052
1018
  </dd>
@@ -1062,7 +1028,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1062
1028
  <dl>
1063
1029
  <dd>
1064
1030
 
1065
- **sessionId:** `string` — The session id for the window.
1031
+ **sessionId:** `string` — ID of the session that owns the window.
1066
1032
 
1067
1033
  </dd>
1068
1034
  </dl>
@@ -1070,7 +1036,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1070
1036
  <dl>
1071
1037
  <dd>
1072
1038
 
1073
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
1039
+ **windowId:** `string` — Airtop window ID of the browser window.
1074
1040
 
1075
1041
  </dd>
1076
1042
  </dl>
@@ -1078,7 +1044,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1078
1044
  <dl>
1079
1045
  <dd>
1080
1046
 
1081
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
1047
+ **request:** `Airtop.WindowLoadUrlV1Body`
1082
1048
 
1083
1049
  </dd>
1084
1050
  </dl>
@@ -1097,7 +1063,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1097
1063
  </dl>
1098
1064
  </details>
1099
1065
 
1100
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
1066
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
1101
1067
  <dl>
1102
1068
  <dd>
1103
1069
 
@@ -1109,7 +1075,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
1109
1075
  <dl>
1110
1076
  <dd>
1111
1077
 
1112
- Execute a type interaction in a specific browser window
1078
+ Closes a browser window in a session
1113
1079
 
1114
1080
  </dd>
1115
1081
  </dl>
@@ -1125,9 +1091,7 @@ Execute a type interaction in a specific browser window
1125
1091
  <dd>
1126
1092
 
1127
1093
  ```typescript
1128
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
1129
- text: "Example text",
1130
- });
1094
+ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
1131
1095
  ```
1132
1096
 
1133
1097
  </dd>
@@ -1143,7 +1107,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
1143
1107
  <dl>
1144
1108
  <dd>
1145
1109
 
1146
- **sessionId:** `string` — The session id for the window.
1110
+ **sessionId:** `string` — ID of the session that owns the window.
1147
1111
 
1148
1112
  </dd>
1149
1113
  </dl>
@@ -1151,7 +1115,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
1151
1115
  <dl>
1152
1116
  <dd>
1153
1117
 
1154
- **windowId:** `string` — The Airtop window id of the browser window.
1118
+ **windowId:** `string` — Airtop window ID of the browser window.
1155
1119
 
1156
1120
  </dd>
1157
1121
  </dl>
@@ -1159,15 +1123,1194 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
1159
1123
  <dl>
1160
1124
  <dd>
1161
1125
 
1162
- **request:** `Airtop.SessionTypeHandlerRequestBody`
1126
+ **requestOptions:** `Windows.RequestOptions`
1127
+
1128
+ </dd>
1129
+ </dl>
1130
+ </dd>
1131
+ </dl>
1163
1132
 
1164
1133
  </dd>
1165
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
1166
1142
 
1167
1143
  <dl>
1168
1144
  <dd>
1169
1145
 
1170
- **requestOptions:** `Windows.RequestOptions`
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`
1347
+
1348
+ </dd>
1349
+ </dl>
1350
+
1351
+ <dl>
1352
+ <dd>
1353
+
1354
+ **requestOptions:** `Windows.RequestOptions`
1355
+
1356
+ </dd>
1357
+ </dl>
1358
+ </dd>
1359
+ </dl>
1360
+
1361
+ </dd>
1362
+ </dl>
1363
+ </details>
1364
+
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`
1171
2314
 
1172
2315
  </dd>
1173
2316
  </dl>