@airtop/sdk 0.1.15 → 0.1.16-beta0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +6 -0
- package/Client.js +14 -4
- package/README.md +8 -6
- package/api/resources/extensionConfigurations/client/Client.d.ts +50 -0
- package/api/resources/extensionConfigurations/client/Client.js +214 -0
- package/api/resources/extensionConfigurations/client/index.d.ts +1 -0
- package/api/resources/extensionConfigurations/client/index.js +17 -0
- package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +13 -0
- package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +5 -0
- package/api/resources/extensionConfigurations/client/requests/index.d.ts +1 -0
- package/api/resources/extensionConfigurations/client/requests/index.js +2 -0
- package/api/resources/extensionConfigurations/index.d.ts +1 -0
- package/api/resources/extensionConfigurations/index.js +17 -0
- package/api/resources/index.d.ts +3 -0
- package/api/resources/index.js +4 -1
- package/api/resources/profiles/client/Client.js +2 -2
- package/api/resources/requests/client/Client.d.ts +34 -0
- package/api/resources/requests/client/Client.js +115 -0
- package/api/resources/requests/client/index.d.ts +1 -0
- package/api/resources/requests/client/index.js +2 -0
- package/api/resources/requests/index.d.ts +1 -0
- package/api/resources/requests/index.js +17 -0
- package/api/resources/sessions/client/Client.d.ts +9 -0
- package/api/resources/sessions/client/Client.js +65 -12
- package/api/resources/windows/client/Client.d.ts +116 -0
- package/api/resources/windows/client/Client.js +654 -26
- package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
- package/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
- package/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +25 -0
- package/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +10 -0
- package/api/types/AsyncConfig.d.ts +7 -0
- package/api/types/AsyncConfig.js +5 -0
- package/api/types/AsyncSessionAiResponseEnvelope.d.ts +9 -0
- package/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
- package/api/types/BrowserWaitSelectorConfig.d.ts +11 -0
- package/api/types/BrowserWaitSelectorConfig.js +5 -0
- package/api/types/ExtensionConfigurationOutput.d.ts +13 -0
- package/api/types/ExtensionConfigurationOutput.js +5 -0
- package/api/types/IntervalMonitorConfig.d.ts +9 -0
- package/api/types/IntervalMonitorConfig.js +5 -0
- package/api/types/MonitorConfig.d.ts +14 -0
- package/api/types/MonitorConfig.js +5 -0
- package/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +12 -0
- package/api/types/MonitorConfigIncludeVisualAnalysis.js +11 -0
- package/api/types/MonitorConfigMonitorType.d.ts +11 -0
- package/api/types/MonitorConfigMonitorType.js +10 -0
- package/api/types/PaginatedExtractionConfig.d.ts +1 -1
- package/api/types/RequestStatusResponse.d.ts +8 -0
- package/api/types/RequestStatusResponse.js +5 -0
- package/api/types/SessionConfigV1.d.ts +3 -1
- package/api/types/VisualAnalysisConfig.d.ts +2 -0
- package/api/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +11 -0
- package/api/types/VisualAnalysisConfigResultSelectionStrategy.js +10 -0
- package/api/types/index.d.ts +10 -0
- package/api/types/index.js +10 -0
- package/dist/Client.d.ts +6 -0
- package/dist/Client.js +14 -4
- package/dist/api/resources/extensionConfigurations/client/Client.d.ts +50 -0
- package/dist/api/resources/extensionConfigurations/client/Client.js +214 -0
- package/dist/api/resources/extensionConfigurations/client/index.d.ts +1 -0
- package/dist/api/resources/extensionConfigurations/client/index.js +17 -0
- package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +13 -0
- package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +5 -0
- package/dist/api/resources/extensionConfigurations/client/requests/index.d.ts +1 -0
- package/dist/api/resources/extensionConfigurations/client/requests/index.js +2 -0
- package/dist/api/resources/extensionConfigurations/index.d.ts +1 -0
- package/dist/api/resources/extensionConfigurations/index.js +17 -0
- package/dist/api/resources/index.d.ts +3 -0
- package/dist/api/resources/index.js +4 -1
- package/dist/api/resources/profiles/client/Client.js +2 -2
- package/dist/api/resources/requests/client/Client.d.ts +34 -0
- package/dist/api/resources/requests/client/Client.js +115 -0
- package/dist/api/resources/requests/client/index.d.ts +1 -0
- package/dist/api/resources/requests/client/index.js +2 -0
- package/dist/api/resources/requests/index.d.ts +1 -0
- package/dist/api/resources/requests/index.js +17 -0
- package/dist/api/resources/sessions/client/Client.d.ts +9 -0
- package/dist/api/resources/sessions/client/Client.js +65 -12
- package/dist/api/resources/windows/client/Client.d.ts +116 -0
- package/dist/api/resources/windows/client/Client.js +654 -26
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +10 -0
- package/dist/api/types/AsyncConfig.d.ts +7 -0
- package/dist/api/types/AsyncConfig.js +5 -0
- package/dist/api/types/AsyncSessionAiResponseEnvelope.d.ts +9 -0
- package/dist/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
- package/dist/api/types/BrowserWaitSelectorConfig.d.ts +11 -0
- package/dist/api/types/BrowserWaitSelectorConfig.js +5 -0
- package/dist/api/types/ExtensionConfigurationOutput.d.ts +13 -0
- package/dist/api/types/ExtensionConfigurationOutput.js +5 -0
- package/dist/api/types/IntervalMonitorConfig.d.ts +9 -0
- package/dist/api/types/IntervalMonitorConfig.js +5 -0
- package/dist/api/types/MonitorConfig.d.ts +14 -0
- package/dist/api/types/MonitorConfig.js +5 -0
- package/dist/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +12 -0
- package/dist/api/types/MonitorConfigIncludeVisualAnalysis.js +11 -0
- package/dist/api/types/MonitorConfigMonitorType.d.ts +11 -0
- package/dist/api/types/MonitorConfigMonitorType.js +10 -0
- package/dist/api/types/PaginatedExtractionConfig.d.ts +1 -1
- package/dist/api/types/RequestStatusResponse.d.ts +8 -0
- package/dist/api/types/RequestStatusResponse.js +5 -0
- package/dist/api/types/SessionConfigV1.d.ts +3 -1
- package/dist/api/types/VisualAnalysisConfig.d.ts +2 -0
- package/dist/api/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +11 -0
- package/dist/api/types/VisualAnalysisConfigResultSelectionStrategy.js +10 -0
- package/dist/api/types/index.d.ts +10 -0
- package/dist/api/types/index.js +10 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
- package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +39 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +10 -0
- package/dist/serialization/resources/windows/client/requests/index.js +21 -1
- package/dist/serialization/types/AsyncConfig.d.ts +12 -0
- package/dist/serialization/types/AsyncConfig.js +33 -0
- package/dist/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
- package/dist/serialization/types/AsyncSessionAiResponseEnvelope.js +36 -0
- package/dist/serialization/types/BrowserWaitSelectorConfig.d.ts +14 -0
- package/dist/serialization/types/BrowserWaitSelectorConfig.js +35 -0
- package/dist/serialization/types/ExtensionConfigurationOutput.d.ts +15 -0
- package/dist/serialization/types/ExtensionConfigurationOutput.js +36 -0
- package/dist/serialization/types/IntervalMonitorConfig.d.ts +13 -0
- package/dist/serialization/types/IntervalMonitorConfig.js +34 -0
- package/dist/serialization/types/MonitorConfig.d.ts +19 -0
- package/dist/serialization/types/MonitorConfig.js +40 -0
- package/dist/serialization/types/MonitorConfigIncludeVisualAnalysis.d.ts +10 -0
- package/dist/serialization/types/MonitorConfigIncludeVisualAnalysis.js +31 -0
- package/dist/serialization/types/MonitorConfigMonitorType.d.ts +10 -0
- package/dist/serialization/types/MonitorConfigMonitorType.js +31 -0
- package/dist/serialization/types/RequestStatusResponse.d.ts +13 -0
- package/dist/serialization/types/RequestStatusResponse.js +34 -0
- package/dist/serialization/types/SessionConfigV1.d.ts +1 -0
- package/dist/serialization/types/SessionConfigV1.js +1 -0
- package/dist/serialization/types/VisualAnalysisConfig.d.ts +2 -0
- package/dist/serialization/types/VisualAnalysisConfig.js +2 -0
- package/dist/serialization/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +10 -0
- package/dist/serialization/types/VisualAnalysisConfigResultSelectionStrategy.js +31 -0
- package/dist/serialization/types/index.d.ts +10 -0
- package/dist/serialization/types/index.js +10 -0
- package/dist/wrapper/AirtopClient.d.ts +1 -0
- package/dist/wrapper/AirtopClient.js +3 -0
- package/dist/wrapper/AirtopWindows.d.ts +10 -0
- package/dist/wrapper/AirtopWindows.js +17 -0
- package/package.json +1 -1
- package/reference.md +1060 -105
- package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
- package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +18 -0
- package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +39 -0
- package/serialization/resources/windows/client/requests/index.d.ts +10 -0
- package/serialization/resources/windows/client/requests/index.js +21 -1
- package/serialization/types/AsyncConfig.d.ts +12 -0
- package/serialization/types/AsyncConfig.js +33 -0
- package/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
- package/serialization/types/AsyncSessionAiResponseEnvelope.js +36 -0
- package/serialization/types/BrowserWaitSelectorConfig.d.ts +14 -0
- package/serialization/types/BrowserWaitSelectorConfig.js +35 -0
- package/serialization/types/ExtensionConfigurationOutput.d.ts +15 -0
- package/serialization/types/ExtensionConfigurationOutput.js +36 -0
- package/serialization/types/IntervalMonitorConfig.d.ts +13 -0
- package/serialization/types/IntervalMonitorConfig.js +34 -0
- package/serialization/types/MonitorConfig.d.ts +19 -0
- package/serialization/types/MonitorConfig.js +40 -0
- package/serialization/types/MonitorConfigIncludeVisualAnalysis.d.ts +10 -0
- package/serialization/types/MonitorConfigIncludeVisualAnalysis.js +31 -0
- package/serialization/types/MonitorConfigMonitorType.d.ts +10 -0
- package/serialization/types/MonitorConfigMonitorType.js +31 -0
- package/serialization/types/RequestStatusResponse.d.ts +13 -0
- package/serialization/types/RequestStatusResponse.js +34 -0
- package/serialization/types/SessionConfigV1.d.ts +1 -0
- package/serialization/types/SessionConfigV1.js +1 -0
- package/serialization/types/VisualAnalysisConfig.d.ts +2 -0
- package/serialization/types/VisualAnalysisConfig.js +2 -0
- package/serialization/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +10 -0
- package/serialization/types/VisualAnalysisConfigResultSelectionStrategy.js +31 -0
- package/serialization/types/index.d.ts +10 -0
- package/serialization/types/index.js +10 -0
- package/wrapper/AirtopClient.d.ts +1 -0
- package/wrapper/AirtopClient.js +3 -0
- package/wrapper/AirtopWindows.d.ts +10 -0
- package/wrapper/AirtopWindows.js +17 -0
package/reference.md
CHANGED
@@ -2,6 +2,660 @@
|
|
2
2
|
|
3
3
|
## Windows
|
4
4
|
|
5
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncClick</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
6
|
+
<dl>
|
7
|
+
<dd>
|
8
|
+
|
9
|
+
#### 📝 Description
|
10
|
+
|
11
|
+
<dl>
|
12
|
+
<dd>
|
13
|
+
|
14
|
+
<dl>
|
15
|
+
<dd>
|
16
|
+
|
17
|
+
Execute a click interaction in a specific browser window asynchronously
|
18
|
+
|
19
|
+
</dd>
|
20
|
+
</dl>
|
21
|
+
</dd>
|
22
|
+
</dl>
|
23
|
+
|
24
|
+
#### 🔌 Usage
|
25
|
+
|
26
|
+
<dl>
|
27
|
+
<dd>
|
28
|
+
|
29
|
+
<dl>
|
30
|
+
<dd>
|
31
|
+
|
32
|
+
```typescript
|
33
|
+
await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
34
|
+
elementDescription: "The login button",
|
35
|
+
});
|
36
|
+
```
|
37
|
+
|
38
|
+
</dd>
|
39
|
+
</dl>
|
40
|
+
</dd>
|
41
|
+
</dl>
|
42
|
+
|
43
|
+
#### ⚙️ Parameters
|
44
|
+
|
45
|
+
<dl>
|
46
|
+
<dd>
|
47
|
+
|
48
|
+
<dl>
|
49
|
+
<dd>
|
50
|
+
|
51
|
+
**sessionId:** `string` — The session id for the window.
|
52
|
+
|
53
|
+
</dd>
|
54
|
+
</dl>
|
55
|
+
|
56
|
+
<dl>
|
57
|
+
<dd>
|
58
|
+
|
59
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
60
|
+
|
61
|
+
</dd>
|
62
|
+
</dl>
|
63
|
+
|
64
|
+
<dl>
|
65
|
+
<dd>
|
66
|
+
|
67
|
+
**request:** `Airtop.AsyncClickRequest`
|
68
|
+
|
69
|
+
</dd>
|
70
|
+
</dl>
|
71
|
+
|
72
|
+
<dl>
|
73
|
+
<dd>
|
74
|
+
|
75
|
+
**requestOptions:** `Windows.RequestOptions`
|
76
|
+
|
77
|
+
</dd>
|
78
|
+
</dl>
|
79
|
+
</dd>
|
80
|
+
</dl>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
</details>
|
85
|
+
|
86
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
87
|
+
<dl>
|
88
|
+
<dd>
|
89
|
+
|
90
|
+
#### 🔌 Usage
|
91
|
+
|
92
|
+
<dl>
|
93
|
+
<dd>
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dd>
|
97
|
+
|
98
|
+
```typescript
|
99
|
+
await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
100
|
+
```
|
101
|
+
|
102
|
+
</dd>
|
103
|
+
</dl>
|
104
|
+
</dd>
|
105
|
+
</dl>
|
106
|
+
|
107
|
+
#### ⚙️ Parameters
|
108
|
+
|
109
|
+
<dl>
|
110
|
+
<dd>
|
111
|
+
|
112
|
+
<dl>
|
113
|
+
<dd>
|
114
|
+
|
115
|
+
**sessionId:** `string` — The session id for the window.
|
116
|
+
|
117
|
+
</dd>
|
118
|
+
</dl>
|
119
|
+
|
120
|
+
<dl>
|
121
|
+
<dd>
|
122
|
+
|
123
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
124
|
+
|
125
|
+
</dd>
|
126
|
+
</dl>
|
127
|
+
|
128
|
+
<dl>
|
129
|
+
<dd>
|
130
|
+
|
131
|
+
**request:** `Airtop.AsyncHoverRequest`
|
132
|
+
|
133
|
+
</dd>
|
134
|
+
</dl>
|
135
|
+
|
136
|
+
<dl>
|
137
|
+
<dd>
|
138
|
+
|
139
|
+
**requestOptions:** `Windows.RequestOptions`
|
140
|
+
|
141
|
+
</dd>
|
142
|
+
</dl>
|
143
|
+
</dd>
|
144
|
+
</dl>
|
145
|
+
|
146
|
+
</dd>
|
147
|
+
</dl>
|
148
|
+
</details>
|
149
|
+
|
150
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
151
|
+
<dl>
|
152
|
+
<dd>
|
153
|
+
|
154
|
+
#### 🔌 Usage
|
155
|
+
|
156
|
+
<dl>
|
157
|
+
<dd>
|
158
|
+
|
159
|
+
<dl>
|
160
|
+
<dd>
|
161
|
+
|
162
|
+
```typescript
|
163
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
164
|
+
```
|
165
|
+
|
166
|
+
</dd>
|
167
|
+
</dl>
|
168
|
+
</dd>
|
169
|
+
</dl>
|
170
|
+
|
171
|
+
#### ⚙️ Parameters
|
172
|
+
|
173
|
+
<dl>
|
174
|
+
<dd>
|
175
|
+
|
176
|
+
<dl>
|
177
|
+
<dd>
|
178
|
+
|
179
|
+
**sessionId:** `string` — The session id for the window.
|
180
|
+
|
181
|
+
</dd>
|
182
|
+
</dl>
|
183
|
+
|
184
|
+
<dl>
|
185
|
+
<dd>
|
186
|
+
|
187
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
188
|
+
|
189
|
+
</dd>
|
190
|
+
</dl>
|
191
|
+
|
192
|
+
<dl>
|
193
|
+
<dd>
|
194
|
+
|
195
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
196
|
+
|
197
|
+
</dd>
|
198
|
+
</dl>
|
199
|
+
|
200
|
+
<dl>
|
201
|
+
<dd>
|
202
|
+
|
203
|
+
**requestOptions:** `Windows.RequestOptions`
|
204
|
+
|
205
|
+
</dd>
|
206
|
+
</dl>
|
207
|
+
</dd>
|
208
|
+
</dl>
|
209
|
+
|
210
|
+
</dd>
|
211
|
+
</dl>
|
212
|
+
</details>
|
213
|
+
|
214
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
215
|
+
<dl>
|
216
|
+
<dd>
|
217
|
+
|
218
|
+
#### 🔌 Usage
|
219
|
+
|
220
|
+
<dl>
|
221
|
+
<dd>
|
222
|
+
|
223
|
+
<dl>
|
224
|
+
<dd>
|
225
|
+
|
226
|
+
```typescript
|
227
|
+
await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
228
|
+
prompt: "What is the main idea of this page?",
|
229
|
+
});
|
230
|
+
```
|
231
|
+
|
232
|
+
</dd>
|
233
|
+
</dl>
|
234
|
+
</dd>
|
235
|
+
</dl>
|
236
|
+
|
237
|
+
#### ⚙️ Parameters
|
238
|
+
|
239
|
+
<dl>
|
240
|
+
<dd>
|
241
|
+
|
242
|
+
<dl>
|
243
|
+
<dd>
|
244
|
+
|
245
|
+
**sessionId:** `string` — The session id for the window.
|
246
|
+
|
247
|
+
</dd>
|
248
|
+
</dl>
|
249
|
+
|
250
|
+
<dl>
|
251
|
+
<dd>
|
252
|
+
|
253
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
254
|
+
|
255
|
+
</dd>
|
256
|
+
</dl>
|
257
|
+
|
258
|
+
<dl>
|
259
|
+
<dd>
|
260
|
+
|
261
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
262
|
+
|
263
|
+
</dd>
|
264
|
+
</dl>
|
265
|
+
|
266
|
+
<dl>
|
267
|
+
<dd>
|
268
|
+
|
269
|
+
**requestOptions:** `Windows.RequestOptions`
|
270
|
+
|
271
|
+
</dd>
|
272
|
+
</dl>
|
273
|
+
</dd>
|
274
|
+
</dl>
|
275
|
+
|
276
|
+
</dd>
|
277
|
+
</dl>
|
278
|
+
</details>
|
279
|
+
|
280
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
281
|
+
<dl>
|
282
|
+
<dd>
|
283
|
+
|
284
|
+
#### 🔌 Usage
|
285
|
+
|
286
|
+
<dl>
|
287
|
+
<dd>
|
288
|
+
|
289
|
+
<dl>
|
290
|
+
<dd>
|
291
|
+
|
292
|
+
```typescript
|
293
|
+
await client.windows.asyncPaginatedExtraction(
|
294
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
295
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
296
|
+
);
|
297
|
+
```
|
298
|
+
|
299
|
+
</dd>
|
300
|
+
</dl>
|
301
|
+
</dd>
|
302
|
+
</dl>
|
303
|
+
|
304
|
+
#### ⚙️ Parameters
|
305
|
+
|
306
|
+
<dl>
|
307
|
+
<dd>
|
308
|
+
|
309
|
+
<dl>
|
310
|
+
<dd>
|
311
|
+
|
312
|
+
**sessionId:** `string` — The session id for the window.
|
313
|
+
|
314
|
+
</dd>
|
315
|
+
</dl>
|
316
|
+
|
317
|
+
<dl>
|
318
|
+
<dd>
|
319
|
+
|
320
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
321
|
+
|
322
|
+
</dd>
|
323
|
+
</dl>
|
324
|
+
|
325
|
+
<dl>
|
326
|
+
<dd>
|
327
|
+
|
328
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
329
|
+
|
330
|
+
</dd>
|
331
|
+
</dl>
|
332
|
+
|
333
|
+
<dl>
|
334
|
+
<dd>
|
335
|
+
|
336
|
+
**requestOptions:** `Windows.RequestOptions`
|
337
|
+
|
338
|
+
</dd>
|
339
|
+
</dl>
|
340
|
+
</dd>
|
341
|
+
</dl>
|
342
|
+
|
343
|
+
</dd>
|
344
|
+
</dl>
|
345
|
+
</details>
|
346
|
+
|
347
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
348
|
+
<dl>
|
349
|
+
<dd>
|
350
|
+
|
351
|
+
#### 📝 Description
|
352
|
+
|
353
|
+
<dl>
|
354
|
+
<dd>
|
355
|
+
|
356
|
+
<dl>
|
357
|
+
<dd>
|
358
|
+
|
359
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
360
|
+
|
361
|
+
</dd>
|
362
|
+
</dl>
|
363
|
+
</dd>
|
364
|
+
</dl>
|
365
|
+
|
366
|
+
#### 🔌 Usage
|
367
|
+
|
368
|
+
<dl>
|
369
|
+
<dd>
|
370
|
+
|
371
|
+
<dl>
|
372
|
+
<dd>
|
373
|
+
|
374
|
+
```typescript
|
375
|
+
await client.windows.asyncPromptContent(
|
376
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
377
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
378
|
+
{
|
379
|
+
prompt: "What is the main idea of this page?",
|
380
|
+
}
|
381
|
+
);
|
382
|
+
```
|
383
|
+
|
384
|
+
</dd>
|
385
|
+
</dl>
|
386
|
+
</dd>
|
387
|
+
</dl>
|
388
|
+
|
389
|
+
#### ⚙️ Parameters
|
390
|
+
|
391
|
+
<dl>
|
392
|
+
<dd>
|
393
|
+
|
394
|
+
<dl>
|
395
|
+
<dd>
|
396
|
+
|
397
|
+
**sessionId:** `string` — The session id for the window.
|
398
|
+
|
399
|
+
</dd>
|
400
|
+
</dl>
|
401
|
+
|
402
|
+
<dl>
|
403
|
+
<dd>
|
404
|
+
|
405
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
406
|
+
|
407
|
+
</dd>
|
408
|
+
</dl>
|
409
|
+
|
410
|
+
<dl>
|
411
|
+
<dd>
|
412
|
+
|
413
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
414
|
+
|
415
|
+
</dd>
|
416
|
+
</dl>
|
417
|
+
|
418
|
+
<dl>
|
419
|
+
<dd>
|
420
|
+
|
421
|
+
**requestOptions:** `Windows.RequestOptions`
|
422
|
+
|
423
|
+
</dd>
|
424
|
+
</dl>
|
425
|
+
</dd>
|
426
|
+
</dl>
|
427
|
+
|
428
|
+
</dd>
|
429
|
+
</dl>
|
430
|
+
</details>
|
431
|
+
|
432
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
433
|
+
<dl>
|
434
|
+
<dd>
|
435
|
+
|
436
|
+
#### 📝 Description
|
437
|
+
|
438
|
+
<dl>
|
439
|
+
<dd>
|
440
|
+
|
441
|
+
<dl>
|
442
|
+
<dd>
|
443
|
+
|
444
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
445
|
+
|
446
|
+
</dd>
|
447
|
+
</dl>
|
448
|
+
</dd>
|
449
|
+
</dl>
|
450
|
+
|
451
|
+
#### 🔌 Usage
|
452
|
+
|
453
|
+
<dl>
|
454
|
+
<dd>
|
455
|
+
|
456
|
+
<dl>
|
457
|
+
<dd>
|
458
|
+
|
459
|
+
```typescript
|
460
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
461
|
+
```
|
462
|
+
|
463
|
+
</dd>
|
464
|
+
</dl>
|
465
|
+
</dd>
|
466
|
+
</dl>
|
467
|
+
|
468
|
+
#### ⚙️ Parameters
|
469
|
+
|
470
|
+
<dl>
|
471
|
+
<dd>
|
472
|
+
|
473
|
+
<dl>
|
474
|
+
<dd>
|
475
|
+
|
476
|
+
**sessionId:** `string` — The session id for the window.
|
477
|
+
|
478
|
+
</dd>
|
479
|
+
</dl>
|
480
|
+
|
481
|
+
<dl>
|
482
|
+
<dd>
|
483
|
+
|
484
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
485
|
+
|
486
|
+
</dd>
|
487
|
+
</dl>
|
488
|
+
|
489
|
+
<dl>
|
490
|
+
<dd>
|
491
|
+
|
492
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
493
|
+
|
494
|
+
</dd>
|
495
|
+
</dl>
|
496
|
+
|
497
|
+
<dl>
|
498
|
+
<dd>
|
499
|
+
|
500
|
+
**requestOptions:** `Windows.RequestOptions`
|
501
|
+
|
502
|
+
</dd>
|
503
|
+
</dl>
|
504
|
+
</dd>
|
505
|
+
</dl>
|
506
|
+
|
507
|
+
</dd>
|
508
|
+
</dl>
|
509
|
+
</details>
|
510
|
+
|
511
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
512
|
+
<dl>
|
513
|
+
<dd>
|
514
|
+
|
515
|
+
#### 📝 Description
|
516
|
+
|
517
|
+
<dl>
|
518
|
+
<dd>
|
519
|
+
|
520
|
+
<dl>
|
521
|
+
<dd>
|
522
|
+
|
523
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
524
|
+
|
525
|
+
</dd>
|
526
|
+
</dl>
|
527
|
+
</dd>
|
528
|
+
</dl>
|
529
|
+
|
530
|
+
#### 🔌 Usage
|
531
|
+
|
532
|
+
<dl>
|
533
|
+
<dd>
|
534
|
+
|
535
|
+
<dl>
|
536
|
+
<dd>
|
537
|
+
|
538
|
+
```typescript
|
539
|
+
await client.windows.asyncSummarizeContent(
|
540
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
541
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
542
|
+
);
|
543
|
+
```
|
544
|
+
|
545
|
+
</dd>
|
546
|
+
</dl>
|
547
|
+
</dd>
|
548
|
+
</dl>
|
549
|
+
|
550
|
+
#### ⚙️ Parameters
|
551
|
+
|
552
|
+
<dl>
|
553
|
+
<dd>
|
554
|
+
|
555
|
+
<dl>
|
556
|
+
<dd>
|
557
|
+
|
558
|
+
**sessionId:** `string` — The session id for the window.
|
559
|
+
|
560
|
+
</dd>
|
561
|
+
</dl>
|
562
|
+
|
563
|
+
<dl>
|
564
|
+
<dd>
|
565
|
+
|
566
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
567
|
+
|
568
|
+
</dd>
|
569
|
+
</dl>
|
570
|
+
|
571
|
+
<dl>
|
572
|
+
<dd>
|
573
|
+
|
574
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
575
|
+
|
576
|
+
</dd>
|
577
|
+
</dl>
|
578
|
+
|
579
|
+
<dl>
|
580
|
+
<dd>
|
581
|
+
|
582
|
+
**requestOptions:** `Windows.RequestOptions`
|
583
|
+
|
584
|
+
</dd>
|
585
|
+
</dl>
|
586
|
+
</dd>
|
587
|
+
</dl>
|
588
|
+
|
589
|
+
</dd>
|
590
|
+
</dl>
|
591
|
+
</details>
|
592
|
+
|
593
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
594
|
+
<dl>
|
595
|
+
<dd>
|
596
|
+
|
597
|
+
#### 🔌 Usage
|
598
|
+
|
599
|
+
<dl>
|
600
|
+
<dd>
|
601
|
+
|
602
|
+
<dl>
|
603
|
+
<dd>
|
604
|
+
|
605
|
+
```typescript
|
606
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
607
|
+
text: "Example text",
|
608
|
+
});
|
609
|
+
```
|
610
|
+
|
611
|
+
</dd>
|
612
|
+
</dl>
|
613
|
+
</dd>
|
614
|
+
</dl>
|
615
|
+
|
616
|
+
#### ⚙️ Parameters
|
617
|
+
|
618
|
+
<dl>
|
619
|
+
<dd>
|
620
|
+
|
621
|
+
<dl>
|
622
|
+
<dd>
|
623
|
+
|
624
|
+
**sessionId:** `string` — The session id for the window.
|
625
|
+
|
626
|
+
</dd>
|
627
|
+
</dl>
|
628
|
+
|
629
|
+
<dl>
|
630
|
+
<dd>
|
631
|
+
|
632
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
633
|
+
|
634
|
+
</dd>
|
635
|
+
</dl>
|
636
|
+
|
637
|
+
<dl>
|
638
|
+
<dd>
|
639
|
+
|
640
|
+
**request:** `Airtop.AsyncTypeRequest`
|
641
|
+
|
642
|
+
</dd>
|
643
|
+
</dl>
|
644
|
+
|
645
|
+
<dl>
|
646
|
+
<dd>
|
647
|
+
|
648
|
+
**requestOptions:** `Windows.RequestOptions`
|
649
|
+
|
650
|
+
</dd>
|
651
|
+
</dl>
|
652
|
+
</dd>
|
653
|
+
</dl>
|
654
|
+
|
655
|
+
</dd>
|
656
|
+
</dl>
|
657
|
+
</details>
|
658
|
+
|
5
659
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
6
660
|
<dl>
|
7
661
|
<dd>
|
@@ -101,8 +755,241 @@ Get information about a browser window in a session, including the live view url
|
|
101
755
|
<dd>
|
102
756
|
|
103
757
|
```typescript
|
104
|
-
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
105
|
-
screenResolution: "1280x720",
|
758
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
759
|
+
screenResolution: "1280x720",
|
760
|
+
});
|
761
|
+
```
|
762
|
+
|
763
|
+
</dd>
|
764
|
+
</dl>
|
765
|
+
</dd>
|
766
|
+
</dl>
|
767
|
+
|
768
|
+
#### ⚙️ Parameters
|
769
|
+
|
770
|
+
<dl>
|
771
|
+
<dd>
|
772
|
+
|
773
|
+
<dl>
|
774
|
+
<dd>
|
775
|
+
|
776
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
777
|
+
|
778
|
+
</dd>
|
779
|
+
</dl>
|
780
|
+
|
781
|
+
<dl>
|
782
|
+
<dd>
|
783
|
+
|
784
|
+
**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.
|
785
|
+
|
786
|
+
</dd>
|
787
|
+
</dl>
|
788
|
+
|
789
|
+
<dl>
|
790
|
+
<dd>
|
791
|
+
|
792
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
793
|
+
|
794
|
+
</dd>
|
795
|
+
</dl>
|
796
|
+
|
797
|
+
<dl>
|
798
|
+
<dd>
|
799
|
+
|
800
|
+
**requestOptions:** `Windows.RequestOptions`
|
801
|
+
|
802
|
+
</dd>
|
803
|
+
</dl>
|
804
|
+
</dd>
|
805
|
+
</dl>
|
806
|
+
|
807
|
+
</dd>
|
808
|
+
</dl>
|
809
|
+
</details>
|
810
|
+
|
811
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
812
|
+
<dl>
|
813
|
+
<dd>
|
814
|
+
|
815
|
+
#### 📝 Description
|
816
|
+
|
817
|
+
<dl>
|
818
|
+
<dd>
|
819
|
+
|
820
|
+
<dl>
|
821
|
+
<dd>
|
822
|
+
|
823
|
+
Loads a specified url on a given window
|
824
|
+
|
825
|
+
</dd>
|
826
|
+
</dl>
|
827
|
+
</dd>
|
828
|
+
</dl>
|
829
|
+
|
830
|
+
#### 🔌 Usage
|
831
|
+
|
832
|
+
<dl>
|
833
|
+
<dd>
|
834
|
+
|
835
|
+
<dl>
|
836
|
+
<dd>
|
837
|
+
|
838
|
+
```typescript
|
839
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
840
|
+
url: "https://www.airtop.ai",
|
841
|
+
});
|
842
|
+
```
|
843
|
+
|
844
|
+
</dd>
|
845
|
+
</dl>
|
846
|
+
</dd>
|
847
|
+
</dl>
|
848
|
+
|
849
|
+
#### ⚙️ Parameters
|
850
|
+
|
851
|
+
<dl>
|
852
|
+
<dd>
|
853
|
+
|
854
|
+
<dl>
|
855
|
+
<dd>
|
856
|
+
|
857
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
858
|
+
|
859
|
+
</dd>
|
860
|
+
</dl>
|
861
|
+
|
862
|
+
<dl>
|
863
|
+
<dd>
|
864
|
+
|
865
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
866
|
+
|
867
|
+
</dd>
|
868
|
+
</dl>
|
869
|
+
|
870
|
+
<dl>
|
871
|
+
<dd>
|
872
|
+
|
873
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
874
|
+
|
875
|
+
</dd>
|
876
|
+
</dl>
|
877
|
+
|
878
|
+
<dl>
|
879
|
+
<dd>
|
880
|
+
|
881
|
+
**requestOptions:** `Windows.RequestOptions`
|
882
|
+
|
883
|
+
</dd>
|
884
|
+
</dl>
|
885
|
+
</dd>
|
886
|
+
</dl>
|
887
|
+
|
888
|
+
</dd>
|
889
|
+
</dl>
|
890
|
+
</details>
|
891
|
+
|
892
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
893
|
+
<dl>
|
894
|
+
<dd>
|
895
|
+
|
896
|
+
#### 📝 Description
|
897
|
+
|
898
|
+
<dl>
|
899
|
+
<dd>
|
900
|
+
|
901
|
+
<dl>
|
902
|
+
<dd>
|
903
|
+
|
904
|
+
Closes a browser window in a session
|
905
|
+
|
906
|
+
</dd>
|
907
|
+
</dl>
|
908
|
+
</dd>
|
909
|
+
</dl>
|
910
|
+
|
911
|
+
#### 🔌 Usage
|
912
|
+
|
913
|
+
<dl>
|
914
|
+
<dd>
|
915
|
+
|
916
|
+
<dl>
|
917
|
+
<dd>
|
918
|
+
|
919
|
+
```typescript
|
920
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
921
|
+
```
|
922
|
+
|
923
|
+
</dd>
|
924
|
+
</dl>
|
925
|
+
</dd>
|
926
|
+
</dl>
|
927
|
+
|
928
|
+
#### ⚙️ Parameters
|
929
|
+
|
930
|
+
<dl>
|
931
|
+
<dd>
|
932
|
+
|
933
|
+
<dl>
|
934
|
+
<dd>
|
935
|
+
|
936
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
937
|
+
|
938
|
+
</dd>
|
939
|
+
</dl>
|
940
|
+
|
941
|
+
<dl>
|
942
|
+
<dd>
|
943
|
+
|
944
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
945
|
+
|
946
|
+
</dd>
|
947
|
+
</dl>
|
948
|
+
|
949
|
+
<dl>
|
950
|
+
<dd>
|
951
|
+
|
952
|
+
**requestOptions:** `Windows.RequestOptions`
|
953
|
+
|
954
|
+
</dd>
|
955
|
+
</dl>
|
956
|
+
</dd>
|
957
|
+
</dl>
|
958
|
+
|
959
|
+
</dd>
|
960
|
+
</dl>
|
961
|
+
</details>
|
962
|
+
|
963
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
964
|
+
<dl>
|
965
|
+
<dd>
|
966
|
+
|
967
|
+
#### 📝 Description
|
968
|
+
|
969
|
+
<dl>
|
970
|
+
<dd>
|
971
|
+
|
972
|
+
<dl>
|
973
|
+
<dd>
|
974
|
+
|
975
|
+
Execute a click interaction in a specific browser window
|
976
|
+
|
977
|
+
</dd>
|
978
|
+
</dl>
|
979
|
+
</dd>
|
980
|
+
</dl>
|
981
|
+
|
982
|
+
#### 🔌 Usage
|
983
|
+
|
984
|
+
<dl>
|
985
|
+
<dd>
|
986
|
+
|
987
|
+
<dl>
|
988
|
+
<dd>
|
989
|
+
|
990
|
+
```typescript
|
991
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
992
|
+
elementDescription: "The login button",
|
106
993
|
});
|
107
994
|
```
|
108
995
|
|
@@ -119,7 +1006,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
119
1006
|
<dl>
|
120
1007
|
<dd>
|
121
1008
|
|
122
|
-
**sessionId:** `string` —
|
1009
|
+
**sessionId:** `string` — The session id for the window.
|
123
1010
|
|
124
1011
|
</dd>
|
125
1012
|
</dl>
|
@@ -127,7 +1014,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
127
1014
|
<dl>
|
128
1015
|
<dd>
|
129
1016
|
|
130
|
-
**windowId:** `string` —
|
1017
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
131
1018
|
|
132
1019
|
</dd>
|
133
1020
|
</dl>
|
@@ -135,7 +1022,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
135
1022
|
<dl>
|
136
1023
|
<dd>
|
137
1024
|
|
138
|
-
**request:** `Airtop.
|
1025
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
139
1026
|
|
140
1027
|
</dd>
|
141
1028
|
</dl>
|
@@ -154,7 +1041,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
154
1041
|
</dl>
|
155
1042
|
</details>
|
156
1043
|
|
157
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1044
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
158
1045
|
<dl>
|
159
1046
|
<dd>
|
160
1047
|
|
@@ -166,7 +1053,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
166
1053
|
<dl>
|
167
1054
|
<dd>
|
168
1055
|
|
169
|
-
|
1056
|
+
Execute a hover interaction in a specific browser window
|
170
1057
|
|
171
1058
|
</dd>
|
172
1059
|
</dl>
|
@@ -182,9 +1069,7 @@ Loads a specified url on a given window
|
|
182
1069
|
<dd>
|
183
1070
|
|
184
1071
|
```typescript
|
185
|
-
await client.windows.
|
186
|
-
url: "https://www.airtop.ai",
|
187
|
-
});
|
1072
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
188
1073
|
```
|
189
1074
|
|
190
1075
|
</dd>
|
@@ -200,7 +1085,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
200
1085
|
<dl>
|
201
1086
|
<dd>
|
202
1087
|
|
203
|
-
**sessionId:** `string` —
|
1088
|
+
**sessionId:** `string` — The session id for the window.
|
204
1089
|
|
205
1090
|
</dd>
|
206
1091
|
</dl>
|
@@ -208,7 +1093,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
208
1093
|
<dl>
|
209
1094
|
<dd>
|
210
1095
|
|
211
|
-
**windowId:** `string` — Airtop window
|
1096
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
212
1097
|
|
213
1098
|
</dd>
|
214
1099
|
</dl>
|
@@ -216,7 +1101,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
216
1101
|
<dl>
|
217
1102
|
<dd>
|
218
1103
|
|
219
|
-
**request:** `Airtop.
|
1104
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
220
1105
|
|
221
1106
|
</dd>
|
222
1107
|
</dl>
|
@@ -235,11 +1120,11 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
235
1120
|
</dl>
|
236
1121
|
</details>
|
237
1122
|
|
238
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1123
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
239
1124
|
<dl>
|
240
1125
|
<dd>
|
241
1126
|
|
242
|
-
####
|
1127
|
+
#### 🔌 Usage
|
243
1128
|
|
244
1129
|
<dl>
|
245
1130
|
<dd>
|
@@ -247,14 +1132,16 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
247
1132
|
<dl>
|
248
1133
|
<dd>
|
249
1134
|
|
250
|
-
|
1135
|
+
```typescript
|
1136
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1137
|
+
```
|
251
1138
|
|
252
1139
|
</dd>
|
253
1140
|
</dl>
|
254
1141
|
</dd>
|
255
1142
|
</dl>
|
256
1143
|
|
257
|
-
####
|
1144
|
+
#### ⚙️ Parameters
|
258
1145
|
|
259
1146
|
<dl>
|
260
1147
|
<dd>
|
@@ -262,24 +1149,15 @@ Closes a browser window in a session
|
|
262
1149
|
<dl>
|
263
1150
|
<dd>
|
264
1151
|
|
265
|
-
|
266
|
-
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
267
|
-
```
|
1152
|
+
**sessionId:** `string` — The session id for the window.
|
268
1153
|
|
269
1154
|
</dd>
|
270
1155
|
</dl>
|
271
|
-
</dd>
|
272
|
-
</dl>
|
273
|
-
|
274
|
-
#### ⚙️ Parameters
|
275
|
-
|
276
|
-
<dl>
|
277
|
-
<dd>
|
278
1156
|
|
279
1157
|
<dl>
|
280
1158
|
<dd>
|
281
1159
|
|
282
|
-
**
|
1160
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
283
1161
|
|
284
1162
|
</dd>
|
285
1163
|
</dl>
|
@@ -287,7 +1165,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
287
1165
|
<dl>
|
288
1166
|
<dd>
|
289
1167
|
|
290
|
-
**
|
1168
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
291
1169
|
|
292
1170
|
</dd>
|
293
1171
|
</dl>
|
@@ -306,7 +1184,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
306
1184
|
</dl>
|
307
1185
|
</details>
|
308
1186
|
|
309
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1187
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
310
1188
|
<dl>
|
311
1189
|
<dd>
|
312
1190
|
|
@@ -318,7 +1196,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
318
1196
|
<dl>
|
319
1197
|
<dd>
|
320
1198
|
|
321
|
-
|
1199
|
+
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?).
|
322
1200
|
|
323
1201
|
</dd>
|
324
1202
|
</dl>
|
@@ -334,8 +1212,8 @@ Execute a click interaction in a specific browser window
|
|
334
1212
|
<dd>
|
335
1213
|
|
336
1214
|
```typescript
|
337
|
-
await client.windows.
|
338
|
-
|
1215
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1216
|
+
prompt: "What is the main idea of this page?",
|
339
1217
|
});
|
340
1218
|
```
|
341
1219
|
|
@@ -368,7 +1246,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
368
1246
|
<dl>
|
369
1247
|
<dd>
|
370
1248
|
|
371
|
-
**request:** `Airtop.
|
1249
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
372
1250
|
|
373
1251
|
</dd>
|
374
1252
|
</dl>
|
@@ -387,7 +1265,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
387
1265
|
</dl>
|
388
1266
|
</details>
|
389
1267
|
|
390
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1268
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
391
1269
|
<dl>
|
392
1270
|
<dd>
|
393
1271
|
|
@@ -399,7 +1277,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
399
1277
|
<dl>
|
400
1278
|
<dd>
|
401
1279
|
|
402
|
-
|
1280
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
403
1281
|
|
404
1282
|
</dd>
|
405
1283
|
</dl>
|
@@ -415,7 +1293,10 @@ Execute a hover interaction in a specific browser window
|
|
415
1293
|
<dd>
|
416
1294
|
|
417
1295
|
```typescript
|
418
|
-
await client.windows.
|
1296
|
+
await client.windows.paginatedExtraction(
|
1297
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1298
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
1299
|
+
);
|
419
1300
|
```
|
420
1301
|
|
421
1302
|
</dd>
|
@@ -447,7 +1328,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
447
1328
|
<dl>
|
448
1329
|
<dd>
|
449
1330
|
|
450
|
-
**request:** `Airtop.
|
1331
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
451
1332
|
|
452
1333
|
</dd>
|
453
1334
|
</dl>
|
@@ -466,7 +1347,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
466
1347
|
</dl>
|
467
1348
|
</details>
|
468
1349
|
|
469
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1350
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
470
1351
|
<dl>
|
471
1352
|
<dd>
|
472
1353
|
|
@@ -478,7 +1359,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
478
1359
|
<dl>
|
479
1360
|
<dd>
|
480
1361
|
|
481
|
-
|
1362
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
482
1363
|
|
483
1364
|
</dd>
|
484
1365
|
</dl>
|
@@ -494,7 +1375,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
494
1375
|
<dd>
|
495
1376
|
|
496
1377
|
```typescript
|
497
|
-
await client.windows.
|
1378
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
498
1379
|
prompt: "What is the main idea of this page?",
|
499
1380
|
});
|
500
1381
|
```
|
@@ -547,7 +1428,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
547
1428
|
</dl>
|
548
1429
|
</details>
|
549
1430
|
|
550
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1431
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
551
1432
|
<dl>
|
552
1433
|
<dd>
|
553
1434
|
|
@@ -559,7 +1440,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
559
1440
|
<dl>
|
560
1441
|
<dd>
|
561
1442
|
|
562
|
-
|
1443
|
+
Scrape a window and return the content as markdown
|
563
1444
|
|
564
1445
|
</dd>
|
565
1446
|
</dl>
|
@@ -575,10 +1456,7 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
575
1456
|
<dd>
|
576
1457
|
|
577
1458
|
```typescript
|
578
|
-
await client.windows.
|
579
|
-
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
580
|
-
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
581
|
-
);
|
1459
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
582
1460
|
```
|
583
1461
|
|
584
1462
|
</dd>
|
@@ -602,7 +1480,7 @@ await client.windows.paginatedExtraction(
|
|
602
1480
|
<dl>
|
603
1481
|
<dd>
|
604
1482
|
|
605
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
1483
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
606
1484
|
|
607
1485
|
</dd>
|
608
1486
|
</dl>
|
@@ -610,7 +1488,7 @@ await client.windows.paginatedExtraction(
|
|
610
1488
|
<dl>
|
611
1489
|
<dd>
|
612
1490
|
|
613
|
-
**request:** `Airtop.
|
1491
|
+
**request:** `Airtop.ScrapeContentRequest`
|
614
1492
|
|
615
1493
|
</dd>
|
616
1494
|
</dl>
|
@@ -629,7 +1507,7 @@ await client.windows.paginatedExtraction(
|
|
629
1507
|
</dl>
|
630
1508
|
</details>
|
631
1509
|
|
632
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1510
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
633
1511
|
<dl>
|
634
1512
|
<dd>
|
635
1513
|
|
@@ -641,7 +1519,7 @@ await client.windows.paginatedExtraction(
|
|
641
1519
|
<dl>
|
642
1520
|
<dd>
|
643
1521
|
|
644
|
-
|
1522
|
+
Take a screenshot of a browser window
|
645
1523
|
|
646
1524
|
</dd>
|
647
1525
|
</dl>
|
@@ -657,9 +1535,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
657
1535
|
<dd>
|
658
1536
|
|
659
1537
|
```typescript
|
660
|
-
await client.windows.
|
661
|
-
prompt: "What is the main idea of this page?",
|
662
|
-
});
|
1538
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
663
1539
|
```
|
664
1540
|
|
665
1541
|
</dd>
|
@@ -691,7 +1567,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
691
1567
|
<dl>
|
692
1568
|
<dd>
|
693
1569
|
|
694
|
-
**request:** `Airtop.
|
1570
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
695
1571
|
|
696
1572
|
</dd>
|
697
1573
|
</dl>
|
@@ -710,7 +1586,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
710
1586
|
</dl>
|
711
1587
|
</details>
|
712
1588
|
|
713
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1589
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
714
1590
|
<dl>
|
715
1591
|
<dd>
|
716
1592
|
|
@@ -722,7 +1598,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
722
1598
|
<dl>
|
723
1599
|
<dd>
|
724
1600
|
|
725
|
-
|
1601
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
726
1602
|
|
727
1603
|
</dd>
|
728
1604
|
</dl>
|
@@ -738,7 +1614,7 @@ Scrape a window and return the content as markdown
|
|
738
1614
|
<dd>
|
739
1615
|
|
740
1616
|
```typescript
|
741
|
-
await client.windows.
|
1617
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
742
1618
|
```
|
743
1619
|
|
744
1620
|
</dd>
|
@@ -762,7 +1638,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
762
1638
|
<dl>
|
763
1639
|
<dd>
|
764
1640
|
|
765
|
-
**windowId:** `string` — The Airtop window id of the browser window to
|
1641
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
766
1642
|
|
767
1643
|
</dd>
|
768
1644
|
</dl>
|
@@ -770,7 +1646,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
770
1646
|
<dl>
|
771
1647
|
<dd>
|
772
1648
|
|
773
|
-
**request:** `Airtop.
|
1649
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
774
1650
|
|
775
1651
|
</dd>
|
776
1652
|
</dl>
|
@@ -789,7 +1665,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
789
1665
|
</dl>
|
790
1666
|
</details>
|
791
1667
|
|
792
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1668
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
793
1669
|
<dl>
|
794
1670
|
<dd>
|
795
1671
|
|
@@ -801,7 +1677,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
801
1677
|
<dl>
|
802
1678
|
<dd>
|
803
1679
|
|
804
|
-
|
1680
|
+
Execute a type interaction in a specific browser window
|
805
1681
|
|
806
1682
|
</dd>
|
807
1683
|
</dl>
|
@@ -817,7 +1693,9 @@ Take a screenshot of a browser window
|
|
817
1693
|
<dd>
|
818
1694
|
|
819
1695
|
```typescript
|
820
|
-
await client.windows.
|
1696
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1697
|
+
text: "Example text",
|
1698
|
+
});
|
821
1699
|
```
|
822
1700
|
|
823
1701
|
</dd>
|
@@ -849,7 +1727,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
849
1727
|
<dl>
|
850
1728
|
<dd>
|
851
1729
|
|
852
|
-
**request:** `Airtop.
|
1730
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
853
1731
|
|
854
1732
|
</dd>
|
855
1733
|
</dl>
|
@@ -868,7 +1746,9 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
868
1746
|
</dl>
|
869
1747
|
</details>
|
870
1748
|
|
871
|
-
|
1749
|
+
## ExtensionConfigurations
|
1750
|
+
|
1751
|
+
<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationDelete</a>({ ...params }) -> void</code></summary>
|
872
1752
|
<dl>
|
873
1753
|
<dd>
|
874
1754
|
|
@@ -880,7 +1760,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
880
1760
|
<dl>
|
881
1761
|
<dd>
|
882
1762
|
|
883
|
-
|
1763
|
+
Delete extension configurations matching by name
|
884
1764
|
|
885
1765
|
</dd>
|
886
1766
|
</dl>
|
@@ -896,7 +1776,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
896
1776
|
<dd>
|
897
1777
|
|
898
1778
|
```typescript
|
899
|
-
await client.
|
1779
|
+
await client.extensionConfigurations.extensionConfigurationDelete();
|
900
1780
|
```
|
901
1781
|
|
902
1782
|
</dd>
|
@@ -912,23 +1792,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
912
1792
|
<dl>
|
913
1793
|
<dd>
|
914
1794
|
|
915
|
-
**
|
916
|
-
|
917
|
-
</dd>
|
918
|
-
</dl>
|
919
|
-
|
920
|
-
<dl>
|
921
|
-
<dd>
|
922
|
-
|
923
|
-
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
924
|
-
|
925
|
-
</dd>
|
926
|
-
</dl>
|
927
|
-
|
928
|
-
<dl>
|
929
|
-
<dd>
|
930
|
-
|
931
|
-
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
1795
|
+
**request:** `Airtop.ExtensionConfigurationDeleteRequest`
|
932
1796
|
|
933
1797
|
</dd>
|
934
1798
|
</dl>
|
@@ -936,7 +1800,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
936
1800
|
<dl>
|
937
1801
|
<dd>
|
938
1802
|
|
939
|
-
**requestOptions:** `
|
1803
|
+
**requestOptions:** `ExtensionConfigurations.RequestOptions`
|
940
1804
|
|
941
1805
|
</dd>
|
942
1806
|
</dl>
|
@@ -947,7 +1811,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
947
1811
|
</dl>
|
948
1812
|
</details>
|
949
1813
|
|
950
|
-
<details><summary><code>client.
|
1814
|
+
<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationGetInfo</a>(name) -> Airtop.ExtensionConfigurationOutput</code></summary>
|
951
1815
|
<dl>
|
952
1816
|
<dd>
|
953
1817
|
|
@@ -959,7 +1823,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
959
1823
|
<dl>
|
960
1824
|
<dd>
|
961
1825
|
|
962
|
-
|
1826
|
+
Get an extension configuration by name
|
963
1827
|
|
964
1828
|
</dd>
|
965
1829
|
</dl>
|
@@ -975,9 +1839,7 @@ Execute a type interaction in a specific browser window
|
|
975
1839
|
<dd>
|
976
1840
|
|
977
1841
|
```typescript
|
978
|
-
await client.
|
979
|
-
text: "Example text",
|
980
|
-
});
|
1842
|
+
await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration");
|
981
1843
|
```
|
982
1844
|
|
983
1845
|
</dd>
|
@@ -993,7 +1855,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
993
1855
|
<dl>
|
994
1856
|
<dd>
|
995
1857
|
|
996
|
-
**
|
1858
|
+
**name:** `string` — Name of the extension configuration to get
|
997
1859
|
|
998
1860
|
</dd>
|
999
1861
|
</dl>
|
@@ -1001,54 +1863,88 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1001
1863
|
<dl>
|
1002
1864
|
<dd>
|
1003
1865
|
|
1004
|
-
**
|
1866
|
+
**requestOptions:** `ExtensionConfigurations.RequestOptions`
|
1867
|
+
|
1868
|
+
</dd>
|
1869
|
+
</dl>
|
1870
|
+
</dd>
|
1871
|
+
</dl>
|
1005
1872
|
|
1006
1873
|
</dd>
|
1007
1874
|
</dl>
|
1875
|
+
</details>
|
1008
1876
|
|
1877
|
+
## Profiles
|
1878
|
+
|
1879
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
1009
1880
|
<dl>
|
1010
1881
|
<dd>
|
1011
1882
|
|
1012
|
-
|
1883
|
+
#### 📝 Description
|
1013
1884
|
|
1014
|
-
|
1015
|
-
|
1885
|
+
<dl>
|
1886
|
+
<dd>
|
1016
1887
|
|
1017
1888
|
<dl>
|
1018
1889
|
<dd>
|
1019
1890
|
|
1020
|
-
|
1891
|
+
Delete profiles matching by id
|
1021
1892
|
|
1022
1893
|
</dd>
|
1023
1894
|
</dl>
|
1024
1895
|
</dd>
|
1025
1896
|
</dl>
|
1026
1897
|
|
1898
|
+
#### 🔌 Usage
|
1899
|
+
|
1900
|
+
<dl>
|
1901
|
+
<dd>
|
1902
|
+
|
1903
|
+
<dl>
|
1904
|
+
<dd>
|
1905
|
+
|
1906
|
+
```typescript
|
1907
|
+
await client.profiles.delete();
|
1908
|
+
```
|
1909
|
+
|
1910
|
+
</dd>
|
1911
|
+
</dl>
|
1027
1912
|
</dd>
|
1028
1913
|
</dl>
|
1029
|
-
</details>
|
1030
1914
|
|
1031
|
-
|
1915
|
+
#### ⚙️ Parameters
|
1032
1916
|
|
1033
|
-
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
1034
1917
|
<dl>
|
1035
1918
|
<dd>
|
1036
1919
|
|
1037
|
-
#### 📝 Description
|
1038
|
-
|
1039
1920
|
<dl>
|
1040
1921
|
<dd>
|
1041
1922
|
|
1923
|
+
**request:** `Airtop.ProfilesDeleteRequest`
|
1924
|
+
|
1925
|
+
</dd>
|
1926
|
+
</dl>
|
1927
|
+
|
1042
1928
|
<dl>
|
1043
1929
|
<dd>
|
1044
1930
|
|
1045
|
-
|
1931
|
+
**requestOptions:** `Profiles.RequestOptions`
|
1046
1932
|
|
1047
1933
|
</dd>
|
1048
1934
|
</dl>
|
1049
1935
|
</dd>
|
1050
1936
|
</dl>
|
1051
1937
|
|
1938
|
+
</dd>
|
1939
|
+
</dl>
|
1940
|
+
</details>
|
1941
|
+
|
1942
|
+
## Requests
|
1943
|
+
|
1944
|
+
<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
|
1945
|
+
<dl>
|
1946
|
+
<dd>
|
1947
|
+
|
1052
1948
|
#### 🔌 Usage
|
1053
1949
|
|
1054
1950
|
<dl>
|
@@ -1058,7 +1954,7 @@ Delete profiles matching by id
|
|
1058
1954
|
<dd>
|
1059
1955
|
|
1060
1956
|
```typescript
|
1061
|
-
await client.
|
1957
|
+
await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
1062
1958
|
```
|
1063
1959
|
|
1064
1960
|
</dd>
|
@@ -1074,7 +1970,7 @@ await client.profiles.delete();
|
|
1074
1970
|
<dl>
|
1075
1971
|
<dd>
|
1076
1972
|
|
1077
|
-
**
|
1973
|
+
**requestId:** `string` — The ID of the request to check.
|
1078
1974
|
|
1079
1975
|
</dd>
|
1080
1976
|
</dl>
|
@@ -1082,7 +1978,7 @@ await client.profiles.delete();
|
|
1082
1978
|
<dl>
|
1083
1979
|
<dd>
|
1084
1980
|
|
1085
|
-
**requestOptions:** `
|
1981
|
+
**requestOptions:** `Requests.RequestOptions`
|
1086
1982
|
|
1087
1983
|
</dd>
|
1088
1984
|
</dl>
|
@@ -1335,6 +2231,65 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1335
2231
|
</dl>
|
1336
2232
|
</details>
|
1337
2233
|
|
2234
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">saveExtensionConfigurationOnTermination</a>(sessionId, extensionConfigurationName) -> void</code></summary>
|
2235
|
+
<dl>
|
2236
|
+
<dd>
|
2237
|
+
|
2238
|
+
#### 🔌 Usage
|
2239
|
+
|
2240
|
+
<dl>
|
2241
|
+
<dd>
|
2242
|
+
|
2243
|
+
<dl>
|
2244
|
+
<dd>
|
2245
|
+
|
2246
|
+
```typescript
|
2247
|
+
await client.sessions.saveExtensionConfigurationOnTermination(
|
2248
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
2249
|
+
"myExtensionConfiguration"
|
2250
|
+
);
|
2251
|
+
```
|
2252
|
+
|
2253
|
+
</dd>
|
2254
|
+
</dl>
|
2255
|
+
</dd>
|
2256
|
+
</dl>
|
2257
|
+
|
2258
|
+
#### ⚙️ Parameters
|
2259
|
+
|
2260
|
+
<dl>
|
2261
|
+
<dd>
|
2262
|
+
|
2263
|
+
<dl>
|
2264
|
+
<dd>
|
2265
|
+
|
2266
|
+
**sessionId:** `string` — ID of the session.
|
2267
|
+
|
2268
|
+
</dd>
|
2269
|
+
</dl>
|
2270
|
+
|
2271
|
+
<dl>
|
2272
|
+
<dd>
|
2273
|
+
|
2274
|
+
**extensionConfigurationName:** `string` — Name under which to save the extension configuration.
|
2275
|
+
|
2276
|
+
</dd>
|
2277
|
+
</dl>
|
2278
|
+
|
2279
|
+
<dl>
|
2280
|
+
<dd>
|
2281
|
+
|
2282
|
+
**requestOptions:** `Sessions.RequestOptions`
|
2283
|
+
|
2284
|
+
</dd>
|
2285
|
+
</dl>
|
2286
|
+
</dd>
|
2287
|
+
</dl>
|
2288
|
+
|
2289
|
+
</dd>
|
2290
|
+
</dl>
|
2291
|
+
</details>
|
2292
|
+
|
1338
2293
|
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">saveProfileOnTermination</a>(sessionId, profileName) -> void</code></summary>
|
1339
2294
|
<dl>
|
1340
2295
|
<dd>
|