@airtop/sdk 0.1.41 → 0.1.42-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/README.md +9 -10
- package/api/resources/automations/client/Client.js +4 -4
- package/api/resources/files/client/Client.js +5 -5
- package/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +1 -1
- package/api/resources/profiles/client/Client.js +1 -1
- package/api/resources/requests/client/Client.js +1 -1
- package/api/resources/sessions/client/Client.js +6 -6
- package/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
- package/api/resources/sessions/types/index.d.ts +1 -1
- package/api/resources/sessions/types/index.js +1 -1
- package/api/resources/windows/client/Client.d.ts +233 -5
- package/api/resources/windows/client/Client.js +1173 -214
- package/api/resources/windows/client/requests/ActRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/ActRequest.js +5 -0
- 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/AsyncFileInputRequest.d.ts +33 -0
- package/api/resources/windows/client/requests/AsyncFileInputRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -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 +27 -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/ExtractRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/ExtractRequest.js +5 -0
- package/api/resources/windows/client/requests/FindManyRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/FindManyRequest.js +5 -0
- package/api/resources/windows/client/requests/FindOneRequest.d.ts +30 -0
- package/api/resources/windows/client/requests/FindOneRequest.js +5 -0
- package/api/resources/windows/client/requests/LlmRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/LlmRequest.js +5 -0
- package/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +25 -0
- package/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
- package/api/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +4 -4
- package/api/resources/windows/client/requests/WaitForPageRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/WaitForPageRequest.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +17 -0
- package/api/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +11 -0
- package/api/resources/windows/types/WaitForPageRequestTargetStatus.js +10 -0
- package/api/resources/windows/types/index.d.ts +1 -0
- package/api/resources/windows/types/index.js +1 -0
- package/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
- package/api/types/AsyncOperatorPromptResponseEnvelope.js +5 -0
- package/api/types/FileEventData.d.ts +7 -0
- package/api/types/FileEventData.js +5 -0
- package/api/types/FileEventMessage.d.ts +2 -1
- package/api/types/index.d.ts +2 -0
- package/api/types/index.js +2 -0
- package/dist/api/resources/automations/client/Client.js +4 -4
- package/dist/api/resources/files/client/Client.js +5 -5
- package/dist/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +1 -1
- package/dist/api/resources/profiles/client/Client.js +1 -1
- package/dist/api/resources/requests/client/Client.js +1 -1
- package/dist/api/resources/sessions/client/Client.js +6 -6
- package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
- package/dist/api/resources/sessions/types/index.d.ts +1 -1
- package/dist/api/resources/sessions/types/index.js +1 -1
- package/dist/api/resources/windows/client/Client.d.ts +233 -5
- package/dist/api/resources/windows/client/Client.js +1173 -214
- package/dist/api/resources/windows/client/requests/ActRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/ActRequest.js +5 -0
- 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/AsyncFileInputRequest.d.ts +33 -0
- package/dist/api/resources/windows/client/requests/AsyncFileInputRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -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 +27 -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/ExtractRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/ExtractRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/FindManyRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/FindManyRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/FindOneRequest.d.ts +30 -0
- package/dist/api/resources/windows/client/requests/FindOneRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/LlmRequest.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/LlmRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +4 -4
- package/dist/api/resources/windows/client/requests/WaitForPageRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/WaitForPageRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +17 -0
- package/dist/api/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +11 -0
- package/dist/api/resources/windows/types/WaitForPageRequestTargetStatus.js +10 -0
- package/dist/api/resources/windows/types/index.d.ts +1 -0
- package/dist/api/resources/windows/types/index.js +1 -0
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.js +5 -0
- package/dist/api/types/FileEventData.d.ts +7 -0
- package/dist/api/types/FileEventData.js +5 -0
- package/dist/api/types/FileEventMessage.d.ts +2 -1
- package/dist/api/types/index.d.ts +2 -0
- package/dist/api/types/index.js +2 -0
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
- package/dist/serialization/resources/sessions/types/index.d.ts +1 -1
- package/dist/serialization/resources/sessions/types/index.js +1 -1
- package/dist/serialization/resources/windows/client/requests/ActRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/ActRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFileInputRequest.d.ts +23 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFileInputRequest.js +54 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
- package/dist/serialization/resources/windows/client/requests/ExtractRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/ExtractRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/FindManyRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/FindManyRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/FindOneRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/FindOneRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/LlmRequest.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/LlmRequest.js +48 -0
- package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
- package/dist/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +2 -1
- package/dist/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js +2 -1
- package/dist/serialization/resources/windows/client/requests/WaitForPageRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/WaitForPageRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/index.js +35 -1
- package/dist/serialization/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +10 -0
- package/dist/serialization/resources/windows/types/WaitForPageRequestTargetStatus.js +41 -0
- package/dist/serialization/resources/windows/types/index.d.ts +1 -0
- package/dist/serialization/resources/windows/types/index.js +1 -0
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
- package/dist/serialization/types/FileEventData.d.ts +13 -0
- package/dist/serialization/types/FileEventData.js +44 -0
- package/dist/serialization/types/FileEventMessage.d.ts +2 -1
- package/dist/serialization/types/FileEventMessage.js +2 -1
- package/dist/serialization/types/index.d.ts +2 -0
- package/dist/serialization/types/index.js +2 -0
- package/dist/utils/upload.js +12 -7
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AirtopSessions.js +12 -5
- package/package.json +1 -1
- package/reference.md +1457 -144
- package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
- package/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
- package/serialization/resources/sessions/types/index.d.ts +1 -1
- package/serialization/resources/sessions/types/index.js +1 -1
- package/serialization/resources/windows/client/requests/ActRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/ActRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncFileInputRequest.d.ts +23 -0
- package/serialization/resources/windows/client/requests/AsyncFileInputRequest.js +54 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
- package/serialization/resources/windows/client/requests/ExtractRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/ExtractRequest.js +50 -0
- package/serialization/resources/windows/client/requests/FindManyRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/FindManyRequest.js +50 -0
- package/serialization/resources/windows/client/requests/FindOneRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/FindOneRequest.js +50 -0
- package/serialization/resources/windows/client/requests/LlmRequest.d.ts +17 -0
- package/serialization/resources/windows/client/requests/LlmRequest.js +48 -0
- package/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +17 -0
- package/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
- package/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.d.ts +2 -1
- package/serialization/resources/windows/client/requests/SessionFileInputHandlerRequestBody.js +2 -1
- package/serialization/resources/windows/client/requests/WaitForPageRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/WaitForPageRequest.js +49 -0
- package/serialization/resources/windows/client/requests/index.d.ts +17 -0
- package/serialization/resources/windows/client/requests/index.js +35 -1
- package/serialization/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +10 -0
- package/serialization/resources/windows/types/WaitForPageRequestTargetStatus.js +41 -0
- package/serialization/resources/windows/types/index.d.ts +1 -0
- package/serialization/resources/windows/types/index.js +1 -0
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
- package/serialization/types/FileEventData.d.ts +13 -0
- package/serialization/types/FileEventData.js +44 -0
- package/serialization/types/FileEventMessage.d.ts +2 -1
- package/serialization/types/FileEventMessage.js +2 -1
- package/serialization/types/index.d.ts +2 -0
- package/serialization/types/index.js +2 -0
- package/utils/upload.js +12 -7
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AirtopSessions.js +12 -5
package/reference.md
CHANGED
@@ -2,6 +2,87 @@
|
|
2
2
|
|
3
3
|
## Windows
|
4
4
|
|
5
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncClick</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
6
|
+
<dl>
|
7
|
+
<dd>
|
8
|
+
|
9
|
+
#### 📝 Description
|
10
|
+
|
11
|
+
<dl>
|
12
|
+
<dd>
|
13
|
+
|
14
|
+
<dl>
|
15
|
+
<dd>
|
16
|
+
|
17
|
+
Execute a click interaction in a specific browser window asynchronously
|
18
|
+
|
19
|
+
</dd>
|
20
|
+
</dl>
|
21
|
+
</dd>
|
22
|
+
</dl>
|
23
|
+
|
24
|
+
#### 🔌 Usage
|
25
|
+
|
26
|
+
<dl>
|
27
|
+
<dd>
|
28
|
+
|
29
|
+
<dl>
|
30
|
+
<dd>
|
31
|
+
|
32
|
+
```typescript
|
33
|
+
await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
34
|
+
elementDescription: "The login button",
|
35
|
+
});
|
36
|
+
```
|
37
|
+
|
38
|
+
</dd>
|
39
|
+
</dl>
|
40
|
+
</dd>
|
41
|
+
</dl>
|
42
|
+
|
43
|
+
#### ⚙️ Parameters
|
44
|
+
|
45
|
+
<dl>
|
46
|
+
<dd>
|
47
|
+
|
48
|
+
<dl>
|
49
|
+
<dd>
|
50
|
+
|
51
|
+
**sessionId:** `string` — The session id for the window.
|
52
|
+
|
53
|
+
</dd>
|
54
|
+
</dl>
|
55
|
+
|
56
|
+
<dl>
|
57
|
+
<dd>
|
58
|
+
|
59
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
60
|
+
|
61
|
+
</dd>
|
62
|
+
</dl>
|
63
|
+
|
64
|
+
<dl>
|
65
|
+
<dd>
|
66
|
+
|
67
|
+
**request:** `Airtop.AsyncClickRequest`
|
68
|
+
|
69
|
+
</dd>
|
70
|
+
</dl>
|
71
|
+
|
72
|
+
<dl>
|
73
|
+
<dd>
|
74
|
+
|
75
|
+
**requestOptions:** `Windows.RequestOptions`
|
76
|
+
|
77
|
+
</dd>
|
78
|
+
</dl>
|
79
|
+
</dd>
|
80
|
+
</dl>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
</details>
|
85
|
+
|
5
86
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
6
87
|
<dl>
|
7
88
|
<dd>
|
@@ -49,15 +130,1226 @@ await client.windows.asyncCreateAutomation(
|
|
49
130
|
<dl>
|
50
131
|
<dd>
|
51
132
|
|
52
|
-
**sessionId:** `string` — The session id for the window.
|
53
|
-
|
54
|
-
</dd>
|
55
|
-
</dl>
|
56
|
-
|
133
|
+
**sessionId:** `string` — The session id for the window.
|
134
|
+
|
135
|
+
</dd>
|
136
|
+
</dl>
|
137
|
+
|
138
|
+
<dl>
|
139
|
+
<dd>
|
140
|
+
|
141
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
142
|
+
|
143
|
+
</dd>
|
144
|
+
</dl>
|
145
|
+
|
146
|
+
<dl>
|
147
|
+
<dd>
|
148
|
+
|
149
|
+
**request:** `Airtop.AsyncCreateAutomationRequest`
|
150
|
+
|
151
|
+
</dd>
|
152
|
+
</dl>
|
153
|
+
|
154
|
+
<dl>
|
155
|
+
<dd>
|
156
|
+
|
157
|
+
**requestOptions:** `Windows.RequestOptions`
|
158
|
+
|
159
|
+
</dd>
|
160
|
+
</dl>
|
161
|
+
</dd>
|
162
|
+
</dl>
|
163
|
+
|
164
|
+
</dd>
|
165
|
+
</dl>
|
166
|
+
</details>
|
167
|
+
|
168
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
169
|
+
<dl>
|
170
|
+
<dd>
|
171
|
+
|
172
|
+
#### 📝 Description
|
173
|
+
|
174
|
+
<dl>
|
175
|
+
<dd>
|
176
|
+
|
177
|
+
<dl>
|
178
|
+
<dd>
|
179
|
+
|
180
|
+
Create a form filler automation asynchronously
|
181
|
+
|
182
|
+
</dd>
|
183
|
+
</dl>
|
184
|
+
</dd>
|
185
|
+
</dl>
|
186
|
+
|
187
|
+
#### 🔌 Usage
|
188
|
+
|
189
|
+
<dl>
|
190
|
+
<dd>
|
191
|
+
|
192
|
+
<dl>
|
193
|
+
<dd>
|
194
|
+
|
195
|
+
```typescript
|
196
|
+
await client.windows.asyncCreateFormFiller(
|
197
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
198
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
199
|
+
);
|
200
|
+
```
|
201
|
+
|
202
|
+
</dd>
|
203
|
+
</dl>
|
204
|
+
</dd>
|
205
|
+
</dl>
|
206
|
+
|
207
|
+
#### ⚙️ Parameters
|
208
|
+
|
209
|
+
<dl>
|
210
|
+
<dd>
|
211
|
+
|
212
|
+
<dl>
|
213
|
+
<dd>
|
214
|
+
|
215
|
+
**sessionId:** `string` — The session id for the window.
|
216
|
+
|
217
|
+
</dd>
|
218
|
+
</dl>
|
219
|
+
|
220
|
+
<dl>
|
221
|
+
<dd>
|
222
|
+
|
223
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
224
|
+
|
225
|
+
</dd>
|
226
|
+
</dl>
|
227
|
+
|
228
|
+
<dl>
|
229
|
+
<dd>
|
230
|
+
|
231
|
+
**request:** `Airtop.AsyncCreateFormFillerRequest`
|
232
|
+
|
233
|
+
</dd>
|
234
|
+
</dl>
|
235
|
+
|
236
|
+
<dl>
|
237
|
+
<dd>
|
238
|
+
|
239
|
+
**requestOptions:** `Windows.RequestOptions`
|
240
|
+
|
241
|
+
</dd>
|
242
|
+
</dl>
|
243
|
+
</dd>
|
244
|
+
</dl>
|
245
|
+
|
246
|
+
</dd>
|
247
|
+
</dl>
|
248
|
+
</details>
|
249
|
+
|
250
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
251
|
+
<dl>
|
252
|
+
<dd>
|
253
|
+
|
254
|
+
#### 📝 Description
|
255
|
+
|
256
|
+
<dl>
|
257
|
+
<dd>
|
258
|
+
|
259
|
+
<dl>
|
260
|
+
<dd>
|
261
|
+
|
262
|
+
Execute an automation of a browser window asynchronously
|
263
|
+
|
264
|
+
</dd>
|
265
|
+
</dl>
|
266
|
+
</dd>
|
267
|
+
</dl>
|
268
|
+
|
269
|
+
#### 🔌 Usage
|
270
|
+
|
271
|
+
<dl>
|
272
|
+
<dd>
|
273
|
+
|
274
|
+
<dl>
|
275
|
+
<dd>
|
276
|
+
|
277
|
+
```typescript
|
278
|
+
await client.windows.asyncExecuteAutomation(
|
279
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
280
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
281
|
+
{
|
282
|
+
automationId: "automationId",
|
283
|
+
},
|
284
|
+
);
|
285
|
+
```
|
286
|
+
|
287
|
+
</dd>
|
288
|
+
</dl>
|
289
|
+
</dd>
|
290
|
+
</dl>
|
291
|
+
|
292
|
+
#### ⚙️ Parameters
|
293
|
+
|
294
|
+
<dl>
|
295
|
+
<dd>
|
296
|
+
|
297
|
+
<dl>
|
298
|
+
<dd>
|
299
|
+
|
300
|
+
**sessionId:** `string` — The session id for the window.
|
301
|
+
|
302
|
+
</dd>
|
303
|
+
</dl>
|
304
|
+
|
305
|
+
<dl>
|
306
|
+
<dd>
|
307
|
+
|
308
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
309
|
+
|
310
|
+
</dd>
|
311
|
+
</dl>
|
312
|
+
|
313
|
+
<dl>
|
314
|
+
<dd>
|
315
|
+
|
316
|
+
**request:** `Airtop.AsyncExecuteAutomationRequest`
|
317
|
+
|
318
|
+
</dd>
|
319
|
+
</dl>
|
320
|
+
|
321
|
+
<dl>
|
322
|
+
<dd>
|
323
|
+
|
324
|
+
**requestOptions:** `Windows.RequestOptions`
|
325
|
+
|
326
|
+
</dd>
|
327
|
+
</dl>
|
328
|
+
</dd>
|
329
|
+
</dl>
|
330
|
+
|
331
|
+
</dd>
|
332
|
+
</dl>
|
333
|
+
</details>
|
334
|
+
|
335
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFileInput</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
336
|
+
<dl>
|
337
|
+
<dd>
|
338
|
+
|
339
|
+
#### 📝 Description
|
340
|
+
|
341
|
+
<dl>
|
342
|
+
<dd>
|
343
|
+
|
344
|
+
<dl>
|
345
|
+
<dd>
|
346
|
+
|
347
|
+
Execute a file input interaction in a specific browser window asynchronously
|
348
|
+
|
349
|
+
</dd>
|
350
|
+
</dl>
|
351
|
+
</dd>
|
352
|
+
</dl>
|
353
|
+
|
354
|
+
#### 🔌 Usage
|
355
|
+
|
356
|
+
<dl>
|
357
|
+
<dd>
|
358
|
+
|
359
|
+
<dl>
|
360
|
+
<dd>
|
361
|
+
|
362
|
+
```typescript
|
363
|
+
await client.windows.asyncFileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
364
|
+
```
|
365
|
+
|
366
|
+
</dd>
|
367
|
+
</dl>
|
368
|
+
</dd>
|
369
|
+
</dl>
|
370
|
+
|
371
|
+
#### ⚙️ Parameters
|
372
|
+
|
373
|
+
<dl>
|
374
|
+
<dd>
|
375
|
+
|
376
|
+
<dl>
|
377
|
+
<dd>
|
378
|
+
|
379
|
+
**sessionId:** `string` — The session id for the window.
|
380
|
+
|
381
|
+
</dd>
|
382
|
+
</dl>
|
383
|
+
|
384
|
+
<dl>
|
385
|
+
<dd>
|
386
|
+
|
387
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
388
|
+
|
389
|
+
</dd>
|
390
|
+
</dl>
|
391
|
+
|
392
|
+
<dl>
|
393
|
+
<dd>
|
394
|
+
|
395
|
+
**request:** `Airtop.AsyncFileInputRequest`
|
396
|
+
|
397
|
+
</dd>
|
398
|
+
</dl>
|
399
|
+
|
400
|
+
<dl>
|
401
|
+
<dd>
|
402
|
+
|
403
|
+
**requestOptions:** `Windows.RequestOptions`
|
404
|
+
|
405
|
+
</dd>
|
406
|
+
</dl>
|
407
|
+
</dd>
|
408
|
+
</dl>
|
409
|
+
|
410
|
+
</dd>
|
411
|
+
</dl>
|
412
|
+
</details>
|
413
|
+
|
414
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
415
|
+
<dl>
|
416
|
+
<dd>
|
417
|
+
|
418
|
+
#### 📝 Description
|
419
|
+
|
420
|
+
<dl>
|
421
|
+
<dd>
|
422
|
+
|
423
|
+
<dl>
|
424
|
+
<dd>
|
425
|
+
|
426
|
+
Fill a form of a browser window asynchronously using a form-filler automation
|
427
|
+
|
428
|
+
</dd>
|
429
|
+
</dl>
|
430
|
+
</dd>
|
431
|
+
</dl>
|
432
|
+
|
433
|
+
#### 🔌 Usage
|
434
|
+
|
435
|
+
<dl>
|
436
|
+
<dd>
|
437
|
+
|
438
|
+
<dl>
|
439
|
+
<dd>
|
440
|
+
|
441
|
+
```typescript
|
442
|
+
await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
443
|
+
automationId: "automationId",
|
444
|
+
});
|
445
|
+
```
|
446
|
+
|
447
|
+
</dd>
|
448
|
+
</dl>
|
449
|
+
</dd>
|
450
|
+
</dl>
|
451
|
+
|
452
|
+
#### ⚙️ Parameters
|
453
|
+
|
454
|
+
<dl>
|
455
|
+
<dd>
|
456
|
+
|
457
|
+
<dl>
|
458
|
+
<dd>
|
459
|
+
|
460
|
+
**sessionId:** `string` — The session id for the window.
|
461
|
+
|
462
|
+
</dd>
|
463
|
+
</dl>
|
464
|
+
|
465
|
+
<dl>
|
466
|
+
<dd>
|
467
|
+
|
468
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
469
|
+
|
470
|
+
</dd>
|
471
|
+
</dl>
|
472
|
+
|
473
|
+
<dl>
|
474
|
+
<dd>
|
475
|
+
|
476
|
+
**request:** `Airtop.AsyncFillFormRequest`
|
477
|
+
|
478
|
+
</dd>
|
479
|
+
</dl>
|
480
|
+
|
481
|
+
<dl>
|
482
|
+
<dd>
|
483
|
+
|
484
|
+
**requestOptions:** `Windows.RequestOptions`
|
485
|
+
|
486
|
+
</dd>
|
487
|
+
</dl>
|
488
|
+
</dd>
|
489
|
+
</dl>
|
490
|
+
|
491
|
+
</dd>
|
492
|
+
</dl>
|
493
|
+
</details>
|
494
|
+
|
495
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
496
|
+
<dl>
|
497
|
+
<dd>
|
498
|
+
|
499
|
+
#### 🔌 Usage
|
500
|
+
|
501
|
+
<dl>
|
502
|
+
<dd>
|
503
|
+
|
504
|
+
<dl>
|
505
|
+
<dd>
|
506
|
+
|
507
|
+
```typescript
|
508
|
+
await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
509
|
+
elementDescription: "The search box input in the top right corner",
|
510
|
+
});
|
511
|
+
```
|
512
|
+
|
513
|
+
</dd>
|
514
|
+
</dl>
|
515
|
+
</dd>
|
516
|
+
</dl>
|
517
|
+
|
518
|
+
#### ⚙️ Parameters
|
519
|
+
|
520
|
+
<dl>
|
521
|
+
<dd>
|
522
|
+
|
523
|
+
<dl>
|
524
|
+
<dd>
|
525
|
+
|
526
|
+
**sessionId:** `string` — The session id for the window.
|
527
|
+
|
528
|
+
</dd>
|
529
|
+
</dl>
|
530
|
+
|
531
|
+
<dl>
|
532
|
+
<dd>
|
533
|
+
|
534
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
535
|
+
|
536
|
+
</dd>
|
537
|
+
</dl>
|
538
|
+
|
539
|
+
<dl>
|
540
|
+
<dd>
|
541
|
+
|
542
|
+
**request:** `Airtop.AsyncHoverRequest`
|
543
|
+
|
544
|
+
</dd>
|
545
|
+
</dl>
|
546
|
+
|
547
|
+
<dl>
|
548
|
+
<dd>
|
549
|
+
|
550
|
+
**requestOptions:** `Windows.RequestOptions`
|
551
|
+
|
552
|
+
</dd>
|
553
|
+
</dl>
|
554
|
+
</dd>
|
555
|
+
</dl>
|
556
|
+
|
557
|
+
</dd>
|
558
|
+
</dl>
|
559
|
+
</details>
|
560
|
+
|
561
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
562
|
+
<dl>
|
563
|
+
<dd>
|
564
|
+
|
565
|
+
#### 🔌 Usage
|
566
|
+
|
567
|
+
<dl>
|
568
|
+
<dd>
|
569
|
+
|
570
|
+
<dl>
|
571
|
+
<dd>
|
572
|
+
|
573
|
+
```typescript
|
574
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
575
|
+
condition: "Determine if the user appears to be signed in to the website",
|
576
|
+
});
|
577
|
+
```
|
578
|
+
|
579
|
+
</dd>
|
580
|
+
</dl>
|
581
|
+
</dd>
|
582
|
+
</dl>
|
583
|
+
|
584
|
+
#### ⚙️ Parameters
|
585
|
+
|
586
|
+
<dl>
|
587
|
+
<dd>
|
588
|
+
|
589
|
+
<dl>
|
590
|
+
<dd>
|
591
|
+
|
592
|
+
**sessionId:** `string` — The session id for the window.
|
593
|
+
|
594
|
+
</dd>
|
595
|
+
</dl>
|
596
|
+
|
597
|
+
<dl>
|
598
|
+
<dd>
|
599
|
+
|
600
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
601
|
+
|
602
|
+
</dd>
|
603
|
+
</dl>
|
604
|
+
|
605
|
+
<dl>
|
606
|
+
<dd>
|
607
|
+
|
608
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
609
|
+
|
610
|
+
</dd>
|
611
|
+
</dl>
|
612
|
+
|
613
|
+
<dl>
|
614
|
+
<dd>
|
615
|
+
|
616
|
+
**requestOptions:** `Windows.RequestOptions`
|
617
|
+
|
618
|
+
</dd>
|
619
|
+
</dl>
|
620
|
+
</dd>
|
621
|
+
</dl>
|
622
|
+
|
623
|
+
</dd>
|
624
|
+
</dl>
|
625
|
+
</details>
|
626
|
+
|
627
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
628
|
+
<dl>
|
629
|
+
<dd>
|
630
|
+
|
631
|
+
#### 🔌 Usage
|
632
|
+
|
633
|
+
<dl>
|
634
|
+
<dd>
|
635
|
+
|
636
|
+
<dl>
|
637
|
+
<dd>
|
638
|
+
|
639
|
+
```typescript
|
640
|
+
await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
641
|
+
prompt: "What is the main idea of this page?",
|
642
|
+
});
|
643
|
+
```
|
644
|
+
|
645
|
+
</dd>
|
646
|
+
</dl>
|
647
|
+
</dd>
|
648
|
+
</dl>
|
649
|
+
|
650
|
+
#### ⚙️ Parameters
|
651
|
+
|
652
|
+
<dl>
|
653
|
+
<dd>
|
654
|
+
|
655
|
+
<dl>
|
656
|
+
<dd>
|
657
|
+
|
658
|
+
**sessionId:** `string` — The session id for the window.
|
659
|
+
|
660
|
+
</dd>
|
661
|
+
</dl>
|
662
|
+
|
663
|
+
<dl>
|
664
|
+
<dd>
|
665
|
+
|
666
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
667
|
+
|
668
|
+
</dd>
|
669
|
+
</dl>
|
670
|
+
|
671
|
+
<dl>
|
672
|
+
<dd>
|
673
|
+
|
674
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
675
|
+
|
676
|
+
</dd>
|
677
|
+
</dl>
|
678
|
+
|
679
|
+
<dl>
|
680
|
+
<dd>
|
681
|
+
|
682
|
+
**requestOptions:** `Windows.RequestOptions`
|
683
|
+
|
684
|
+
</dd>
|
685
|
+
</dl>
|
686
|
+
</dd>
|
687
|
+
</dl>
|
688
|
+
|
689
|
+
</dd>
|
690
|
+
</dl>
|
691
|
+
</details>
|
692
|
+
|
693
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
694
|
+
<dl>
|
695
|
+
<dd>
|
696
|
+
|
697
|
+
#### 🔌 Usage
|
698
|
+
|
699
|
+
<dl>
|
700
|
+
<dd>
|
701
|
+
|
702
|
+
<dl>
|
703
|
+
<dd>
|
704
|
+
|
705
|
+
```typescript
|
706
|
+
await client.windows.asyncPaginatedExtraction(
|
707
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
708
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
709
|
+
{
|
710
|
+
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.",
|
711
|
+
},
|
712
|
+
);
|
713
|
+
```
|
714
|
+
|
715
|
+
</dd>
|
716
|
+
</dl>
|
717
|
+
</dd>
|
718
|
+
</dl>
|
719
|
+
|
720
|
+
#### ⚙️ Parameters
|
721
|
+
|
722
|
+
<dl>
|
723
|
+
<dd>
|
724
|
+
|
725
|
+
<dl>
|
726
|
+
<dd>
|
727
|
+
|
728
|
+
**sessionId:** `string` — The session id for the window.
|
729
|
+
|
730
|
+
</dd>
|
731
|
+
</dl>
|
732
|
+
|
733
|
+
<dl>
|
734
|
+
<dd>
|
735
|
+
|
736
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
737
|
+
|
738
|
+
</dd>
|
739
|
+
</dl>
|
740
|
+
|
741
|
+
<dl>
|
742
|
+
<dd>
|
743
|
+
|
744
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
745
|
+
|
746
|
+
</dd>
|
747
|
+
</dl>
|
748
|
+
|
749
|
+
<dl>
|
750
|
+
<dd>
|
751
|
+
|
752
|
+
**requestOptions:** `Windows.RequestOptions`
|
753
|
+
|
754
|
+
</dd>
|
755
|
+
</dl>
|
756
|
+
</dd>
|
757
|
+
</dl>
|
758
|
+
|
759
|
+
</dd>
|
760
|
+
</dl>
|
761
|
+
</details>
|
762
|
+
|
763
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
764
|
+
<dl>
|
765
|
+
<dd>
|
766
|
+
|
767
|
+
#### 📝 Description
|
768
|
+
|
769
|
+
<dl>
|
770
|
+
<dd>
|
771
|
+
|
772
|
+
<dl>
|
773
|
+
<dd>
|
774
|
+
|
775
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
776
|
+
|
777
|
+
</dd>
|
778
|
+
</dl>
|
779
|
+
</dd>
|
780
|
+
</dl>
|
781
|
+
|
782
|
+
#### 🔌 Usage
|
783
|
+
|
784
|
+
<dl>
|
785
|
+
<dd>
|
786
|
+
|
787
|
+
<dl>
|
788
|
+
<dd>
|
789
|
+
|
790
|
+
```typescript
|
791
|
+
await client.windows.asyncPromptContent(
|
792
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
793
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
794
|
+
{
|
795
|
+
prompt: "What is the main idea of this page?",
|
796
|
+
},
|
797
|
+
);
|
798
|
+
```
|
799
|
+
|
800
|
+
</dd>
|
801
|
+
</dl>
|
802
|
+
</dd>
|
803
|
+
</dl>
|
804
|
+
|
805
|
+
#### ⚙️ Parameters
|
806
|
+
|
807
|
+
<dl>
|
808
|
+
<dd>
|
809
|
+
|
810
|
+
<dl>
|
811
|
+
<dd>
|
812
|
+
|
813
|
+
**sessionId:** `string` — The session id for the window.
|
814
|
+
|
815
|
+
</dd>
|
816
|
+
</dl>
|
817
|
+
|
818
|
+
<dl>
|
819
|
+
<dd>
|
820
|
+
|
821
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
822
|
+
|
823
|
+
</dd>
|
824
|
+
</dl>
|
825
|
+
|
826
|
+
<dl>
|
827
|
+
<dd>
|
828
|
+
|
829
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
830
|
+
|
831
|
+
</dd>
|
832
|
+
</dl>
|
833
|
+
|
834
|
+
<dl>
|
835
|
+
<dd>
|
836
|
+
|
837
|
+
**requestOptions:** `Windows.RequestOptions`
|
838
|
+
|
839
|
+
</dd>
|
840
|
+
</dl>
|
841
|
+
</dd>
|
842
|
+
</dl>
|
843
|
+
|
844
|
+
</dd>
|
845
|
+
</dl>
|
846
|
+
</details>
|
847
|
+
|
848
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
849
|
+
<dl>
|
850
|
+
<dd>
|
851
|
+
|
852
|
+
#### 📝 Description
|
853
|
+
|
854
|
+
<dl>
|
855
|
+
<dd>
|
856
|
+
|
857
|
+
<dl>
|
858
|
+
<dd>
|
859
|
+
|
860
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
861
|
+
|
862
|
+
</dd>
|
863
|
+
</dl>
|
864
|
+
</dd>
|
865
|
+
</dl>
|
866
|
+
|
867
|
+
#### 🔌 Usage
|
868
|
+
|
869
|
+
<dl>
|
870
|
+
<dd>
|
871
|
+
|
872
|
+
<dl>
|
873
|
+
<dd>
|
874
|
+
|
875
|
+
```typescript
|
876
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
877
|
+
```
|
878
|
+
|
879
|
+
</dd>
|
880
|
+
</dl>
|
881
|
+
</dd>
|
882
|
+
</dl>
|
883
|
+
|
884
|
+
#### ⚙️ Parameters
|
885
|
+
|
886
|
+
<dl>
|
887
|
+
<dd>
|
888
|
+
|
889
|
+
<dl>
|
890
|
+
<dd>
|
891
|
+
|
892
|
+
**sessionId:** `string` — The session id for the window.
|
893
|
+
|
894
|
+
</dd>
|
895
|
+
</dl>
|
896
|
+
|
897
|
+
<dl>
|
898
|
+
<dd>
|
899
|
+
|
900
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
901
|
+
|
902
|
+
</dd>
|
903
|
+
</dl>
|
904
|
+
|
905
|
+
<dl>
|
906
|
+
<dd>
|
907
|
+
|
908
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
909
|
+
|
910
|
+
</dd>
|
911
|
+
</dl>
|
912
|
+
|
913
|
+
<dl>
|
914
|
+
<dd>
|
915
|
+
|
916
|
+
**requestOptions:** `Windows.RequestOptions`
|
917
|
+
|
918
|
+
</dd>
|
919
|
+
</dl>
|
920
|
+
</dd>
|
921
|
+
</dl>
|
922
|
+
|
923
|
+
</dd>
|
924
|
+
</dl>
|
925
|
+
</details>
|
926
|
+
|
927
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
928
|
+
<dl>
|
929
|
+
<dd>
|
930
|
+
|
931
|
+
#### 📝 Description
|
932
|
+
|
933
|
+
<dl>
|
934
|
+
<dd>
|
935
|
+
|
936
|
+
<dl>
|
937
|
+
<dd>
|
938
|
+
|
939
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
940
|
+
|
941
|
+
</dd>
|
942
|
+
</dl>
|
943
|
+
</dd>
|
944
|
+
</dl>
|
945
|
+
|
946
|
+
#### 🔌 Usage
|
947
|
+
|
948
|
+
<dl>
|
949
|
+
<dd>
|
950
|
+
|
951
|
+
<dl>
|
952
|
+
<dd>
|
953
|
+
|
954
|
+
```typescript
|
955
|
+
await client.windows.asyncSummarizeContent(
|
956
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
957
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
958
|
+
);
|
959
|
+
```
|
960
|
+
|
961
|
+
</dd>
|
962
|
+
</dl>
|
963
|
+
</dd>
|
964
|
+
</dl>
|
965
|
+
|
966
|
+
#### ⚙️ Parameters
|
967
|
+
|
968
|
+
<dl>
|
969
|
+
<dd>
|
970
|
+
|
971
|
+
<dl>
|
972
|
+
<dd>
|
973
|
+
|
974
|
+
**sessionId:** `string` — The session id for the window.
|
975
|
+
|
976
|
+
</dd>
|
977
|
+
</dl>
|
978
|
+
|
979
|
+
<dl>
|
980
|
+
<dd>
|
981
|
+
|
982
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
983
|
+
|
984
|
+
</dd>
|
985
|
+
</dl>
|
986
|
+
|
987
|
+
<dl>
|
988
|
+
<dd>
|
989
|
+
|
990
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
991
|
+
|
992
|
+
</dd>
|
993
|
+
</dl>
|
994
|
+
|
995
|
+
<dl>
|
996
|
+
<dd>
|
997
|
+
|
998
|
+
**requestOptions:** `Windows.RequestOptions`
|
999
|
+
|
1000
|
+
</dd>
|
1001
|
+
</dl>
|
1002
|
+
</dd>
|
1003
|
+
</dl>
|
1004
|
+
|
1005
|
+
</dd>
|
1006
|
+
</dl>
|
1007
|
+
</details>
|
1008
|
+
|
1009
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1010
|
+
<dl>
|
1011
|
+
<dd>
|
1012
|
+
|
1013
|
+
#### 🔌 Usage
|
1014
|
+
|
1015
|
+
<dl>
|
1016
|
+
<dd>
|
1017
|
+
|
1018
|
+
<dl>
|
1019
|
+
<dd>
|
1020
|
+
|
1021
|
+
```typescript
|
1022
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1023
|
+
text: "Example text",
|
1024
|
+
});
|
1025
|
+
```
|
1026
|
+
|
1027
|
+
</dd>
|
1028
|
+
</dl>
|
1029
|
+
</dd>
|
1030
|
+
</dl>
|
1031
|
+
|
1032
|
+
#### ⚙️ Parameters
|
1033
|
+
|
1034
|
+
<dl>
|
1035
|
+
<dd>
|
1036
|
+
|
1037
|
+
<dl>
|
1038
|
+
<dd>
|
1039
|
+
|
1040
|
+
**sessionId:** `string` — The session id for the window.
|
1041
|
+
|
1042
|
+
</dd>
|
1043
|
+
</dl>
|
1044
|
+
|
1045
|
+
<dl>
|
1046
|
+
<dd>
|
1047
|
+
|
1048
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1049
|
+
|
1050
|
+
</dd>
|
1051
|
+
</dl>
|
1052
|
+
|
1053
|
+
<dl>
|
1054
|
+
<dd>
|
1055
|
+
|
1056
|
+
**request:** `Airtop.AsyncTypeRequest`
|
1057
|
+
|
1058
|
+
</dd>
|
1059
|
+
</dl>
|
1060
|
+
|
1061
|
+
<dl>
|
1062
|
+
<dd>
|
1063
|
+
|
1064
|
+
**requestOptions:** `Windows.RequestOptions`
|
1065
|
+
|
1066
|
+
</dd>
|
1067
|
+
</dl>
|
1068
|
+
</dd>
|
1069
|
+
</dl>
|
1070
|
+
|
1071
|
+
</dd>
|
1072
|
+
</dl>
|
1073
|
+
</details>
|
1074
|
+
|
1075
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
1076
|
+
<dl>
|
1077
|
+
<dd>
|
1078
|
+
|
1079
|
+
#### 📝 Description
|
1080
|
+
|
1081
|
+
<dl>
|
1082
|
+
<dd>
|
1083
|
+
|
1084
|
+
<dl>
|
1085
|
+
<dd>
|
1086
|
+
|
1087
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
1088
|
+
|
1089
|
+
</dd>
|
1090
|
+
</dl>
|
1091
|
+
</dd>
|
1092
|
+
</dl>
|
1093
|
+
|
1094
|
+
#### 🔌 Usage
|
1095
|
+
|
1096
|
+
<dl>
|
1097
|
+
<dd>
|
1098
|
+
|
1099
|
+
<dl>
|
1100
|
+
<dd>
|
1101
|
+
|
1102
|
+
```typescript
|
1103
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
1104
|
+
```
|
1105
|
+
|
1106
|
+
</dd>
|
1107
|
+
</dl>
|
1108
|
+
</dd>
|
1109
|
+
</dl>
|
1110
|
+
|
1111
|
+
#### ⚙️ Parameters
|
1112
|
+
|
1113
|
+
<dl>
|
1114
|
+
<dd>
|
1115
|
+
|
1116
|
+
<dl>
|
1117
|
+
<dd>
|
1118
|
+
|
1119
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1120
|
+
|
1121
|
+
</dd>
|
1122
|
+
</dl>
|
1123
|
+
|
1124
|
+
<dl>
|
1125
|
+
<dd>
|
1126
|
+
|
1127
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
1128
|
+
|
1129
|
+
</dd>
|
1130
|
+
</dl>
|
1131
|
+
|
1132
|
+
<dl>
|
1133
|
+
<dd>
|
1134
|
+
|
1135
|
+
**requestOptions:** `Windows.RequestOptions`
|
1136
|
+
|
1137
|
+
</dd>
|
1138
|
+
</dl>
|
1139
|
+
</dd>
|
1140
|
+
</dl>
|
1141
|
+
|
1142
|
+
</dd>
|
1143
|
+
</dl>
|
1144
|
+
</details>
|
1145
|
+
|
1146
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
|
1147
|
+
<dl>
|
1148
|
+
<dd>
|
1149
|
+
|
1150
|
+
#### 📝 Description
|
1151
|
+
|
1152
|
+
<dl>
|
1153
|
+
<dd>
|
1154
|
+
|
1155
|
+
<dl>
|
1156
|
+
<dd>
|
1157
|
+
|
1158
|
+
Get information about a browser window in a session, including the live view url.
|
1159
|
+
|
1160
|
+
</dd>
|
1161
|
+
</dl>
|
1162
|
+
</dd>
|
1163
|
+
</dl>
|
1164
|
+
|
1165
|
+
#### 🔌 Usage
|
1166
|
+
|
1167
|
+
<dl>
|
1168
|
+
<dd>
|
1169
|
+
|
1170
|
+
<dl>
|
1171
|
+
<dd>
|
1172
|
+
|
1173
|
+
```typescript
|
1174
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1175
|
+
screenResolution: "1280x720",
|
1176
|
+
});
|
1177
|
+
```
|
1178
|
+
|
1179
|
+
</dd>
|
1180
|
+
</dl>
|
1181
|
+
</dd>
|
1182
|
+
</dl>
|
1183
|
+
|
1184
|
+
#### ⚙️ Parameters
|
1185
|
+
|
1186
|
+
<dl>
|
1187
|
+
<dd>
|
1188
|
+
|
1189
|
+
<dl>
|
1190
|
+
<dd>
|
1191
|
+
|
1192
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1193
|
+
|
1194
|
+
</dd>
|
1195
|
+
</dl>
|
1196
|
+
|
1197
|
+
<dl>
|
1198
|
+
<dd>
|
1199
|
+
|
1200
|
+
**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.
|
1201
|
+
|
1202
|
+
</dd>
|
1203
|
+
</dl>
|
1204
|
+
|
1205
|
+
<dl>
|
1206
|
+
<dd>
|
1207
|
+
|
1208
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
1209
|
+
|
1210
|
+
</dd>
|
1211
|
+
</dl>
|
1212
|
+
|
1213
|
+
<dl>
|
1214
|
+
<dd>
|
1215
|
+
|
1216
|
+
**requestOptions:** `Windows.RequestOptions`
|
1217
|
+
|
1218
|
+
</dd>
|
1219
|
+
</dl>
|
1220
|
+
</dd>
|
1221
|
+
</dl>
|
1222
|
+
|
1223
|
+
</dd>
|
1224
|
+
</dl>
|
1225
|
+
</details>
|
1226
|
+
|
1227
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
1228
|
+
<dl>
|
1229
|
+
<dd>
|
1230
|
+
|
1231
|
+
#### 📝 Description
|
1232
|
+
|
1233
|
+
<dl>
|
1234
|
+
<dd>
|
1235
|
+
|
1236
|
+
<dl>
|
1237
|
+
<dd>
|
1238
|
+
|
1239
|
+
Loads a specified url on a given window
|
1240
|
+
|
1241
|
+
</dd>
|
1242
|
+
</dl>
|
1243
|
+
</dd>
|
1244
|
+
</dl>
|
1245
|
+
|
1246
|
+
#### 🔌 Usage
|
1247
|
+
|
1248
|
+
<dl>
|
1249
|
+
<dd>
|
1250
|
+
|
1251
|
+
<dl>
|
1252
|
+
<dd>
|
1253
|
+
|
1254
|
+
```typescript
|
1255
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1256
|
+
url: "https://www.airtop.ai",
|
1257
|
+
});
|
1258
|
+
```
|
1259
|
+
|
1260
|
+
</dd>
|
1261
|
+
</dl>
|
1262
|
+
</dd>
|
1263
|
+
</dl>
|
1264
|
+
|
1265
|
+
#### ⚙️ Parameters
|
1266
|
+
|
1267
|
+
<dl>
|
1268
|
+
<dd>
|
1269
|
+
|
1270
|
+
<dl>
|
1271
|
+
<dd>
|
1272
|
+
|
1273
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1274
|
+
|
1275
|
+
</dd>
|
1276
|
+
</dl>
|
1277
|
+
|
1278
|
+
<dl>
|
1279
|
+
<dd>
|
1280
|
+
|
1281
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1282
|
+
|
1283
|
+
</dd>
|
1284
|
+
</dl>
|
1285
|
+
|
1286
|
+
<dl>
|
1287
|
+
<dd>
|
1288
|
+
|
1289
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
1290
|
+
|
1291
|
+
</dd>
|
1292
|
+
</dl>
|
1293
|
+
|
1294
|
+
<dl>
|
1295
|
+
<dd>
|
1296
|
+
|
1297
|
+
**requestOptions:** `Windows.RequestOptions`
|
1298
|
+
|
1299
|
+
</dd>
|
1300
|
+
</dl>
|
1301
|
+
</dd>
|
1302
|
+
</dl>
|
1303
|
+
|
1304
|
+
</dd>
|
1305
|
+
</dl>
|
1306
|
+
</details>
|
1307
|
+
|
1308
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
1309
|
+
<dl>
|
1310
|
+
<dd>
|
1311
|
+
|
1312
|
+
#### 📝 Description
|
1313
|
+
|
1314
|
+
<dl>
|
1315
|
+
<dd>
|
1316
|
+
|
1317
|
+
<dl>
|
1318
|
+
<dd>
|
1319
|
+
|
1320
|
+
Closes a browser window in a session
|
1321
|
+
|
1322
|
+
</dd>
|
1323
|
+
</dl>
|
1324
|
+
</dd>
|
1325
|
+
</dl>
|
1326
|
+
|
1327
|
+
#### 🔌 Usage
|
1328
|
+
|
1329
|
+
<dl>
|
1330
|
+
<dd>
|
1331
|
+
|
1332
|
+
<dl>
|
1333
|
+
<dd>
|
1334
|
+
|
1335
|
+
```typescript
|
1336
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
1337
|
+
```
|
1338
|
+
|
1339
|
+
</dd>
|
1340
|
+
</dl>
|
1341
|
+
</dd>
|
1342
|
+
</dl>
|
1343
|
+
|
1344
|
+
#### ⚙️ Parameters
|
1345
|
+
|
1346
|
+
<dl>
|
1347
|
+
<dd>
|
1348
|
+
|
57
1349
|
<dl>
|
58
1350
|
<dd>
|
59
1351
|
|
60
|
-
**
|
1352
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
61
1353
|
|
62
1354
|
</dd>
|
63
1355
|
</dl>
|
@@ -65,7 +1357,7 @@ await client.windows.asyncCreateAutomation(
|
|
65
1357
|
<dl>
|
66
1358
|
<dd>
|
67
1359
|
|
68
|
-
**
|
1360
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
69
1361
|
|
70
1362
|
</dd>
|
71
1363
|
</dl>
|
@@ -84,7 +1376,7 @@ await client.windows.asyncCreateAutomation(
|
|
84
1376
|
</dl>
|
85
1377
|
</details>
|
86
1378
|
|
87
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1379
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
88
1380
|
<dl>
|
89
1381
|
<dd>
|
90
1382
|
|
@@ -96,7 +1388,7 @@ await client.windows.asyncCreateAutomation(
|
|
96
1388
|
<dl>
|
97
1389
|
<dd>
|
98
1390
|
|
99
|
-
|
1391
|
+
Execute a click interaction in a specific browser window
|
100
1392
|
|
101
1393
|
</dd>
|
102
1394
|
</dl>
|
@@ -112,10 +1404,9 @@ Create a form filler automation asynchronously
|
|
112
1404
|
<dd>
|
113
1405
|
|
114
1406
|
```typescript
|
115
|
-
await client.windows.
|
116
|
-
"
|
117
|
-
|
118
|
-
);
|
1407
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1408
|
+
elementDescription: "The login button",
|
1409
|
+
});
|
119
1410
|
```
|
120
1411
|
|
121
1412
|
</dd>
|
@@ -147,7 +1438,7 @@ await client.windows.asyncCreateFormFiller(
|
|
147
1438
|
<dl>
|
148
1439
|
<dd>
|
149
1440
|
|
150
|
-
**request:** `Airtop.
|
1441
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
151
1442
|
|
152
1443
|
</dd>
|
153
1444
|
</dl>
|
@@ -166,7 +1457,7 @@ await client.windows.asyncCreateFormFiller(
|
|
166
1457
|
</dl>
|
167
1458
|
</details>
|
168
1459
|
|
169
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1460
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
170
1461
|
<dl>
|
171
1462
|
<dd>
|
172
1463
|
|
@@ -178,7 +1469,7 @@ await client.windows.asyncCreateFormFiller(
|
|
178
1469
|
<dl>
|
179
1470
|
<dd>
|
180
1471
|
|
181
|
-
|
1472
|
+
Create a form-filler automation synchronously for the form loaded in the browser window
|
182
1473
|
|
183
1474
|
</dd>
|
184
1475
|
</dl>
|
@@ -194,13 +1485,7 @@ Execute an automation of a browser window asynchronously
|
|
194
1485
|
<dd>
|
195
1486
|
|
196
1487
|
```typescript
|
197
|
-
await client.windows.
|
198
|
-
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
199
|
-
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
200
|
-
{
|
201
|
-
automationId: "automationId",
|
202
|
-
},
|
203
|
-
);
|
1488
|
+
await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
204
1489
|
```
|
205
1490
|
|
206
1491
|
</dd>
|
@@ -232,7 +1517,7 @@ await client.windows.asyncExecuteAutomation(
|
|
232
1517
|
<dl>
|
233
1518
|
<dd>
|
234
1519
|
|
235
|
-
**request:** `Airtop.
|
1520
|
+
**request:** `Airtop.CreateFormFillerRequest`
|
236
1521
|
|
237
1522
|
</dd>
|
238
1523
|
</dl>
|
@@ -251,7 +1536,7 @@ await client.windows.asyncExecuteAutomation(
|
|
251
1536
|
</dl>
|
252
1537
|
</details>
|
253
1538
|
|
254
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1539
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fileInput</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
255
1540
|
<dl>
|
256
1541
|
<dd>
|
257
1542
|
|
@@ -263,7 +1548,13 @@ await client.windows.asyncExecuteAutomation(
|
|
263
1548
|
<dl>
|
264
1549
|
<dd>
|
265
1550
|
|
266
|
-
|
1551
|
+
Execute a file input interaction in a specific browser window.
|
1552
|
+
includeHiddenElements defaults to true and considers hidden file input elements.
|
1553
|
+
If there is only one file input element, it will be used directly.
|
1554
|
+
If there are multiple file input elements, the elementDescription will be used by AI to
|
1555
|
+
select among them.
|
1556
|
+
If no file input elements are found by inspecting the page structure, elementDescription
|
1557
|
+
will be used by AI to try to find a match visually.
|
267
1558
|
|
268
1559
|
</dd>
|
269
1560
|
</dl>
|
@@ -279,9 +1570,7 @@ Fill a form of a browser window asynchronously using a form-filler automation
|
|
279
1570
|
<dd>
|
280
1571
|
|
281
1572
|
```typescript
|
282
|
-
await client.windows.
|
283
|
-
automationId: "automationId",
|
284
|
-
});
|
1573
|
+
await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
285
1574
|
```
|
286
1575
|
|
287
1576
|
</dd>
|
@@ -313,7 +1602,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
313
1602
|
<dl>
|
314
1603
|
<dd>
|
315
1604
|
|
316
|
-
**request:** `Airtop.
|
1605
|
+
**request:** `Airtop.SessionFileInputHandlerRequestBody`
|
317
1606
|
|
318
1607
|
</dd>
|
319
1608
|
</dl>
|
@@ -332,7 +1621,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
332
1621
|
</dl>
|
333
1622
|
</details>
|
334
1623
|
|
335
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1624
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
336
1625
|
<dl>
|
337
1626
|
<dd>
|
338
1627
|
|
@@ -344,7 +1633,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
344
1633
|
<dl>
|
345
1634
|
<dd>
|
346
1635
|
|
347
|
-
|
1636
|
+
Fill a form of a browser window synchronously using a form-filler automation
|
348
1637
|
|
349
1638
|
</dd>
|
350
1639
|
</dl>
|
@@ -360,7 +1649,9 @@ Creates a new browser window in a session. Optionally, you can specify a url to
|
|
360
1649
|
<dd>
|
361
1650
|
|
362
1651
|
```typescript
|
363
|
-
await client.windows.
|
1652
|
+
await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1653
|
+
automationId: "automationId",
|
1654
|
+
});
|
364
1655
|
```
|
365
1656
|
|
366
1657
|
</dd>
|
@@ -376,7 +1667,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
376
1667
|
<dl>
|
377
1668
|
<dd>
|
378
1669
|
|
379
|
-
**sessionId:** `string` —
|
1670
|
+
**sessionId:** `string` — The session id for the window.
|
380
1671
|
|
381
1672
|
</dd>
|
382
1673
|
</dl>
|
@@ -384,7 +1675,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
384
1675
|
<dl>
|
385
1676
|
<dd>
|
386
1677
|
|
387
|
-
**
|
1678
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1679
|
+
|
1680
|
+
</dd>
|
1681
|
+
</dl>
|
1682
|
+
|
1683
|
+
<dl>
|
1684
|
+
<dd>
|
1685
|
+
|
1686
|
+
**request:** `Airtop.FillFormRequest`
|
388
1687
|
|
389
1688
|
</dd>
|
390
1689
|
</dl>
|
@@ -403,7 +1702,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
403
1702
|
</dl>
|
404
1703
|
</details>
|
405
1704
|
|
406
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1705
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
407
1706
|
<dl>
|
408
1707
|
<dd>
|
409
1708
|
|
@@ -415,7 +1714,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
415
1714
|
<dl>
|
416
1715
|
<dd>
|
417
1716
|
|
418
|
-
|
1717
|
+
Execute a hover interaction in a specific browser window
|
419
1718
|
|
420
1719
|
</dd>
|
421
1720
|
</dl>
|
@@ -431,8 +1730,8 @@ Get information about a browser window in a session, including the live view url
|
|
431
1730
|
<dd>
|
432
1731
|
|
433
1732
|
```typescript
|
434
|
-
await client.windows.
|
435
|
-
|
1733
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1734
|
+
elementDescription: "The search box input in the top right corner",
|
436
1735
|
});
|
437
1736
|
```
|
438
1737
|
|
@@ -449,7 +1748,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
449
1748
|
<dl>
|
450
1749
|
<dd>
|
451
1750
|
|
452
|
-
**sessionId:** `string` —
|
1751
|
+
**sessionId:** `string` — The session id for the window.
|
453
1752
|
|
454
1753
|
</dd>
|
455
1754
|
</dl>
|
@@ -457,7 +1756,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
457
1756
|
<dl>
|
458
1757
|
<dd>
|
459
1758
|
|
460
|
-
**windowId:** `string` —
|
1759
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
461
1760
|
|
462
1761
|
</dd>
|
463
1762
|
</dl>
|
@@ -465,7 +1764,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
465
1764
|
<dl>
|
466
1765
|
<dd>
|
467
1766
|
|
468
|
-
**request:** `Airtop.
|
1767
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
469
1768
|
|
470
1769
|
</dd>
|
471
1770
|
</dl>
|
@@ -484,25 +1783,10 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
484
1783
|
</dl>
|
485
1784
|
</details>
|
486
1785
|
|
487
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
488
|
-
<dl>
|
489
|
-
<dd>
|
490
|
-
|
491
|
-
#### 📝 Description
|
492
|
-
|
493
|
-
<dl>
|
494
|
-
<dd>
|
495
|
-
|
1786
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
496
1787
|
<dl>
|
497
1788
|
<dd>
|
498
1789
|
|
499
|
-
Loads a specified url on a given window
|
500
|
-
|
501
|
-
</dd>
|
502
|
-
</dl>
|
503
|
-
</dd>
|
504
|
-
</dl>
|
505
|
-
|
506
1790
|
#### 🔌 Usage
|
507
1791
|
|
508
1792
|
<dl>
|
@@ -512,8 +1796,8 @@ Loads a specified url on a given window
|
|
512
1796
|
<dd>
|
513
1797
|
|
514
1798
|
```typescript
|
515
|
-
await client.windows.
|
516
|
-
|
1799
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1800
|
+
condition: "Determine if the user appears to be signed in to the website",
|
517
1801
|
});
|
518
1802
|
```
|
519
1803
|
|
@@ -530,7 +1814,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
530
1814
|
<dl>
|
531
1815
|
<dd>
|
532
1816
|
|
533
|
-
**sessionId:** `string` —
|
1817
|
+
**sessionId:** `string` — The session id for the window.
|
534
1818
|
|
535
1819
|
</dd>
|
536
1820
|
</dl>
|
@@ -538,7 +1822,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
538
1822
|
<dl>
|
539
1823
|
<dd>
|
540
1824
|
|
541
|
-
**windowId:** `string` — Airtop window
|
1825
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
542
1826
|
|
543
1827
|
</dd>
|
544
1828
|
</dl>
|
@@ -546,7 +1830,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
546
1830
|
<dl>
|
547
1831
|
<dd>
|
548
1832
|
|
549
|
-
**request:** `Airtop.
|
1833
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
550
1834
|
|
551
1835
|
</dd>
|
552
1836
|
</dl>
|
@@ -565,7 +1849,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
565
1849
|
</dl>
|
566
1850
|
</details>
|
567
1851
|
|
568
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1852
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">operatorPrompt</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncOperatorPromptResponseEnvelope</code></summary>
|
569
1853
|
<dl>
|
570
1854
|
<dd>
|
571
1855
|
|
@@ -577,7 +1861,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
577
1861
|
<dl>
|
578
1862
|
<dd>
|
579
1863
|
|
580
|
-
|
1864
|
+
Prompt OpenAI Operator
|
581
1865
|
|
582
1866
|
</dd>
|
583
1867
|
</dl>
|
@@ -593,7 +1877,9 @@ Closes a browser window in a session
|
|
593
1877
|
<dd>
|
594
1878
|
|
595
1879
|
```typescript
|
596
|
-
await client.windows.
|
1880
|
+
await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1881
|
+
prompt: "What is the latest news about OpenAI?",
|
1882
|
+
});
|
597
1883
|
```
|
598
1884
|
|
599
1885
|
</dd>
|
@@ -625,6 +1911,14 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
625
1911
|
<dl>
|
626
1912
|
<dd>
|
627
1913
|
|
1914
|
+
**request:** `Airtop.OperatorPromptV1Body`
|
1915
|
+
|
1916
|
+
</dd>
|
1917
|
+
</dl>
|
1918
|
+
|
1919
|
+
<dl>
|
1920
|
+
<dd>
|
1921
|
+
|
628
1922
|
**requestOptions:** `Windows.RequestOptions`
|
629
1923
|
|
630
1924
|
</dd>
|
@@ -636,7 +1930,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
636
1930
|
</dl>
|
637
1931
|
</details>
|
638
1932
|
|
639
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1933
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
640
1934
|
<dl>
|
641
1935
|
<dd>
|
642
1936
|
|
@@ -648,7 +1942,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
648
1942
|
<dl>
|
649
1943
|
<dd>
|
650
1944
|
|
651
|
-
|
1945
|
+
Submit a prompt that queries the content of a specific browser window. You may extract content from the page, or ask a question about the page and allow the AI to answer it (ex. Is the user logged in?).
|
652
1946
|
|
653
1947
|
</dd>
|
654
1948
|
</dl>
|
@@ -664,8 +1958,8 @@ Execute a click interaction in a specific browser window
|
|
664
1958
|
<dd>
|
665
1959
|
|
666
1960
|
```typescript
|
667
|
-
await client.windows.
|
668
|
-
|
1961
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1962
|
+
prompt: "What is the main idea of this page?",
|
669
1963
|
});
|
670
1964
|
```
|
671
1965
|
|
@@ -698,7 +1992,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
698
1992
|
<dl>
|
699
1993
|
<dd>
|
700
1994
|
|
701
|
-
**request:** `Airtop.
|
1995
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
702
1996
|
|
703
1997
|
</dd>
|
704
1998
|
</dl>
|
@@ -717,7 +2011,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
717
2011
|
</dl>
|
718
2012
|
</details>
|
719
2013
|
|
720
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2014
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
721
2015
|
<dl>
|
722
2016
|
<dd>
|
723
2017
|
|
@@ -729,7 +2023,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
729
2023
|
<dl>
|
730
2024
|
<dd>
|
731
2025
|
|
732
|
-
|
2026
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
733
2027
|
|
734
2028
|
</dd>
|
735
2029
|
</dl>
|
@@ -745,7 +2039,13 @@ Create a form-filler automation synchronously for the form loaded in the browser
|
|
745
2039
|
<dd>
|
746
2040
|
|
747
2041
|
```typescript
|
748
|
-
await client.windows.
|
2042
|
+
await client.windows.paginatedExtraction(
|
2043
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
2044
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
2045
|
+
{
|
2046
|
+
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.",
|
2047
|
+
},
|
2048
|
+
);
|
749
2049
|
```
|
750
2050
|
|
751
2051
|
</dd>
|
@@ -777,7 +2077,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
777
2077
|
<dl>
|
778
2078
|
<dd>
|
779
2079
|
|
780
|
-
**request:** `Airtop.
|
2080
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
781
2081
|
|
782
2082
|
</dd>
|
783
2083
|
</dl>
|
@@ -796,7 +2096,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
796
2096
|
</dl>
|
797
2097
|
</details>
|
798
2098
|
|
799
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2099
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
800
2100
|
<dl>
|
801
2101
|
<dd>
|
802
2102
|
|
@@ -808,7 +2108,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
808
2108
|
<dl>
|
809
2109
|
<dd>
|
810
2110
|
|
811
|
-
|
2111
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
812
2112
|
|
813
2113
|
</dd>
|
814
2114
|
</dl>
|
@@ -824,8 +2124,8 @@ Execute a file input interaction in a specific browser window
|
|
824
2124
|
<dd>
|
825
2125
|
|
826
2126
|
```typescript
|
827
|
-
await client.windows.
|
828
|
-
|
2127
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2128
|
+
prompt: "What is the main idea of this page?",
|
829
2129
|
});
|
830
2130
|
```
|
831
2131
|
|
@@ -858,7 +2158,7 @@ await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
858
2158
|
<dl>
|
859
2159
|
<dd>
|
860
2160
|
|
861
|
-
**request:** `Airtop.
|
2161
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
862
2162
|
|
863
2163
|
</dd>
|
864
2164
|
</dl>
|
@@ -877,7 +2177,7 @@ await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
877
2177
|
</dl>
|
878
2178
|
</details>
|
879
2179
|
|
880
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2180
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
881
2181
|
<dl>
|
882
2182
|
<dd>
|
883
2183
|
|
@@ -889,7 +2189,7 @@ await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
889
2189
|
<dl>
|
890
2190
|
<dd>
|
891
2191
|
|
892
|
-
|
2192
|
+
Scrape a window and return the content as markdown
|
893
2193
|
|
894
2194
|
</dd>
|
895
2195
|
</dl>
|
@@ -905,9 +2205,7 @@ Fill a form of a browser window synchronously using a form-filler automation
|
|
905
2205
|
<dd>
|
906
2206
|
|
907
2207
|
```typescript
|
908
|
-
await client.windows.
|
909
|
-
automationId: "automationId",
|
910
|
-
});
|
2208
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
911
2209
|
```
|
912
2210
|
|
913
2211
|
</dd>
|
@@ -931,7 +2229,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
931
2229
|
<dl>
|
932
2230
|
<dd>
|
933
2231
|
|
934
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
2232
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
935
2233
|
|
936
2234
|
</dd>
|
937
2235
|
</dl>
|
@@ -939,7 +2237,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
939
2237
|
<dl>
|
940
2238
|
<dd>
|
941
2239
|
|
942
|
-
**request:** `Airtop.
|
2240
|
+
**request:** `Airtop.ScrapeContentRequest`
|
943
2241
|
|
944
2242
|
</dd>
|
945
2243
|
</dl>
|
@@ -958,7 +2256,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
958
2256
|
</dl>
|
959
2257
|
</details>
|
960
2258
|
|
961
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2259
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
962
2260
|
<dl>
|
963
2261
|
<dd>
|
964
2262
|
|
@@ -970,7 +2268,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
970
2268
|
<dl>
|
971
2269
|
<dd>
|
972
2270
|
|
973
|
-
|
2271
|
+
Take a screenshot of a browser window
|
974
2272
|
|
975
2273
|
</dd>
|
976
2274
|
</dl>
|
@@ -986,9 +2284,7 @@ Execute a hover interaction in a specific browser window
|
|
986
2284
|
<dd>
|
987
2285
|
|
988
2286
|
```typescript
|
989
|
-
await client.windows.
|
990
|
-
elementDescription: "The search box input in the top right corner",
|
991
|
-
});
|
2287
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
992
2288
|
```
|
993
2289
|
|
994
2290
|
</dd>
|
@@ -1020,7 +2316,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1020
2316
|
<dl>
|
1021
2317
|
<dd>
|
1022
2318
|
|
1023
|
-
**request:** `Airtop.
|
2319
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
1024
2320
|
|
1025
2321
|
</dd>
|
1026
2322
|
</dl>
|
@@ -1039,10 +2335,25 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1039
2335
|
</dl>
|
1040
2336
|
</details>
|
1041
2337
|
|
1042
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2338
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2339
|
+
<dl>
|
2340
|
+
<dd>
|
2341
|
+
|
2342
|
+
#### 📝 Description
|
2343
|
+
|
2344
|
+
<dl>
|
2345
|
+
<dd>
|
2346
|
+
|
1043
2347
|
<dl>
|
1044
2348
|
<dd>
|
1045
2349
|
|
2350
|
+
Execute a scroll interaction in a specific browser window
|
2351
|
+
|
2352
|
+
</dd>
|
2353
|
+
</dl>
|
2354
|
+
</dd>
|
2355
|
+
</dl>
|
2356
|
+
|
1046
2357
|
#### 🔌 Usage
|
1047
2358
|
|
1048
2359
|
<dl>
|
@@ -1052,9 +2363,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1052
2363
|
<dd>
|
1053
2364
|
|
1054
2365
|
```typescript
|
1055
|
-
await client.windows.
|
1056
|
-
condition: "Determine if the user appears to be signed in to the website",
|
1057
|
-
});
|
2366
|
+
await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1058
2367
|
```
|
1059
2368
|
|
1060
2369
|
</dd>
|
@@ -1086,7 +2395,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1086
2395
|
<dl>
|
1087
2396
|
<dd>
|
1088
2397
|
|
1089
|
-
**request:** `Airtop.
|
2398
|
+
**request:** `Airtop.SessionScrollHandlerRequestBody`
|
1090
2399
|
|
1091
2400
|
</dd>
|
1092
2401
|
</dl>
|
@@ -1105,7 +2414,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1105
2414
|
</dl>
|
1106
2415
|
</details>
|
1107
2416
|
|
1108
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2417
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1109
2418
|
<dl>
|
1110
2419
|
<dd>
|
1111
2420
|
|
@@ -1117,7 +2426,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1117
2426
|
<dl>
|
1118
2427
|
<dd>
|
1119
2428
|
|
1120
|
-
|
2429
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
1121
2430
|
|
1122
2431
|
</dd>
|
1123
2432
|
</dl>
|
@@ -1133,9 +2442,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
1133
2442
|
<dd>
|
1134
2443
|
|
1135
2444
|
```typescript
|
1136
|
-
await client.windows.
|
1137
|
-
prompt: "What is the main idea of this page?",
|
1138
|
-
});
|
2445
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1139
2446
|
```
|
1140
2447
|
|
1141
2448
|
</dd>
|
@@ -1159,7 +2466,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1159
2466
|
<dl>
|
1160
2467
|
<dd>
|
1161
2468
|
|
1162
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
2469
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
1163
2470
|
|
1164
2471
|
</dd>
|
1165
2472
|
</dl>
|
@@ -1167,7 +2474,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1167
2474
|
<dl>
|
1168
2475
|
<dd>
|
1169
2476
|
|
1170
|
-
**request:** `Airtop.
|
2477
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
1171
2478
|
|
1172
2479
|
</dd>
|
1173
2480
|
</dl>
|
@@ -1186,7 +2493,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1186
2493
|
</dl>
|
1187
2494
|
</details>
|
1188
2495
|
|
1189
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2496
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1190
2497
|
<dl>
|
1191
2498
|
<dd>
|
1192
2499
|
|
@@ -1198,7 +2505,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1198
2505
|
<dl>
|
1199
2506
|
<dd>
|
1200
2507
|
|
1201
|
-
|
2508
|
+
Execute a type interaction in a specific browser window
|
1202
2509
|
|
1203
2510
|
</dd>
|
1204
2511
|
</dl>
|
@@ -1214,13 +2521,9 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
1214
2521
|
<dd>
|
1215
2522
|
|
1216
2523
|
```typescript
|
1217
|
-
await client.windows.
|
1218
|
-
"
|
1219
|
-
|
1220
|
-
{
|
1221
|
-
prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list.",
|
1222
|
-
},
|
1223
|
-
);
|
2524
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2525
|
+
text: "Example text",
|
2526
|
+
});
|
1224
2527
|
```
|
1225
2528
|
|
1226
2529
|
</dd>
|
@@ -1252,7 +2555,7 @@ await client.windows.paginatedExtraction(
|
|
1252
2555
|
<dl>
|
1253
2556
|
<dd>
|
1254
2557
|
|
1255
|
-
**request:** `Airtop.
|
2558
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
1256
2559
|
|
1257
2560
|
</dd>
|
1258
2561
|
</dl>
|
@@ -1271,7 +2574,7 @@ await client.windows.paginatedExtraction(
|
|
1271
2574
|
</dl>
|
1272
2575
|
</details>
|
1273
2576
|
|
1274
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2577
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">act</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1275
2578
|
<dl>
|
1276
2579
|
<dd>
|
1277
2580
|
|
@@ -1283,7 +2586,7 @@ await client.windows.paginatedExtraction(
|
|
1283
2586
|
<dl>
|
1284
2587
|
<dd>
|
1285
2588
|
|
1286
|
-
|
2589
|
+
Perform actions in a specific browser window based on a prompt
|
1287
2590
|
|
1288
2591
|
</dd>
|
1289
2592
|
</dl>
|
@@ -1299,8 +2602,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
1299
2602
|
<dd>
|
1300
2603
|
|
1301
2604
|
```typescript
|
1302
|
-
await client.windows.
|
1303
|
-
|
2605
|
+
await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2606
|
+
jobId: "123",
|
2607
|
+
prompt: "Click the login button",
|
1304
2608
|
});
|
1305
2609
|
```
|
1306
2610
|
|
@@ -1333,7 +2637,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1333
2637
|
<dl>
|
1334
2638
|
<dd>
|
1335
2639
|
|
1336
|
-
**request:** `Airtop.
|
2640
|
+
**request:** `Airtop.ActRequest`
|
1337
2641
|
|
1338
2642
|
</dd>
|
1339
2643
|
</dl>
|
@@ -1352,7 +2656,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1352
2656
|
</dl>
|
1353
2657
|
</details>
|
1354
2658
|
|
1355
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2659
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">extract</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1356
2660
|
<dl>
|
1357
2661
|
<dd>
|
1358
2662
|
|
@@ -1364,7 +2668,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1364
2668
|
<dl>
|
1365
2669
|
<dd>
|
1366
2670
|
|
1367
|
-
|
2671
|
+
Extract data from a specific browser window based on a prompt
|
1368
2672
|
|
1369
2673
|
</dd>
|
1370
2674
|
</dl>
|
@@ -1380,7 +2684,10 @@ Scrape a window and return the content as markdown
|
|
1380
2684
|
<dd>
|
1381
2685
|
|
1382
2686
|
```typescript
|
1383
|
-
await client.windows.
|
2687
|
+
await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2688
|
+
jobId: "123",
|
2689
|
+
prompt: "Extract all product prices from this page",
|
2690
|
+
});
|
1384
2691
|
```
|
1385
2692
|
|
1386
2693
|
</dd>
|
@@ -1404,7 +2711,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1404
2711
|
<dl>
|
1405
2712
|
<dd>
|
1406
2713
|
|
1407
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
2714
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1408
2715
|
|
1409
2716
|
</dd>
|
1410
2717
|
</dl>
|
@@ -1412,7 +2719,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1412
2719
|
<dl>
|
1413
2720
|
<dd>
|
1414
2721
|
|
1415
|
-
**request:** `Airtop.
|
2722
|
+
**request:** `Airtop.ExtractRequest`
|
1416
2723
|
|
1417
2724
|
</dd>
|
1418
2725
|
</dl>
|
@@ -1431,7 +2738,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1431
2738
|
</dl>
|
1432
2739
|
</details>
|
1433
2740
|
|
1434
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2741
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findMany</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1435
2742
|
<dl>
|
1436
2743
|
<dd>
|
1437
2744
|
|
@@ -1443,7 +2750,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1443
2750
|
<dl>
|
1444
2751
|
<dd>
|
1445
2752
|
|
1446
|
-
|
2753
|
+
Find multiple elements in a browser window based on a prompt
|
1447
2754
|
|
1448
2755
|
</dd>
|
1449
2756
|
</dl>
|
@@ -1459,7 +2766,10 @@ Take a screenshot of a browser window
|
|
1459
2766
|
<dd>
|
1460
2767
|
|
1461
2768
|
```typescript
|
1462
|
-
await client.windows.
|
2769
|
+
await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2770
|
+
jobId: "123",
|
2771
|
+
prompt: "Find all the news articles",
|
2772
|
+
});
|
1463
2773
|
```
|
1464
2774
|
|
1465
2775
|
</dd>
|
@@ -1491,7 +2801,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1491
2801
|
<dl>
|
1492
2802
|
<dd>
|
1493
2803
|
|
1494
|
-
**request:** `Airtop.
|
2804
|
+
**request:** `Airtop.FindManyRequest`
|
1495
2805
|
|
1496
2806
|
</dd>
|
1497
2807
|
</dl>
|
@@ -1510,7 +2820,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1510
2820
|
</dl>
|
1511
2821
|
</details>
|
1512
2822
|
|
1513
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2823
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">findOne</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1514
2824
|
<dl>
|
1515
2825
|
<dd>
|
1516
2826
|
|
@@ -1522,7 +2832,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
1522
2832
|
<dl>
|
1523
2833
|
<dd>
|
1524
2834
|
|
1525
|
-
|
2835
|
+
Find a specific element in a browser window based on a prompt
|
1526
2836
|
|
1527
2837
|
</dd>
|
1528
2838
|
</dl>
|
@@ -1538,7 +2848,10 @@ Execute a scroll interaction in a specific browser window
|
|
1538
2848
|
<dd>
|
1539
2849
|
|
1540
2850
|
```typescript
|
1541
|
-
await client.windows.
|
2851
|
+
await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2852
|
+
jobId: "123",
|
2853
|
+
prompt: "Find the login button",
|
2854
|
+
});
|
1542
2855
|
```
|
1543
2856
|
|
1544
2857
|
</dd>
|
@@ -1570,7 +2883,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1570
2883
|
<dl>
|
1571
2884
|
<dd>
|
1572
2885
|
|
1573
|
-
**request:** `Airtop.
|
2886
|
+
**request:** `Airtop.FindOneRequest`
|
1574
2887
|
|
1575
2888
|
</dd>
|
1576
2889
|
</dl>
|
@@ -1589,7 +2902,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1589
2902
|
</dl>
|
1590
2903
|
</details>
|
1591
2904
|
|
1592
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2905
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">llm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1593
2906
|
<dl>
|
1594
2907
|
<dd>
|
1595
2908
|
|
@@ -1601,7 +2914,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1601
2914
|
<dl>
|
1602
2915
|
<dd>
|
1603
2916
|
|
1604
|
-
|
2917
|
+
Send a prompt to an LLM with context from the browser window
|
1605
2918
|
|
1606
2919
|
</dd>
|
1607
2920
|
</dl>
|
@@ -1617,7 +2930,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
1617
2930
|
<dd>
|
1618
2931
|
|
1619
2932
|
```typescript
|
1620
|
-
await client.windows.
|
2933
|
+
await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2934
|
+
prompt: "Tell me about this webpage",
|
2935
|
+
});
|
1621
2936
|
```
|
1622
2937
|
|
1623
2938
|
</dd>
|
@@ -1641,7 +2956,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1641
2956
|
<dl>
|
1642
2957
|
<dd>
|
1643
2958
|
|
1644
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
2959
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1645
2960
|
|
1646
2961
|
</dd>
|
1647
2962
|
</dl>
|
@@ -1649,7 +2964,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1649
2964
|
<dl>
|
1650
2965
|
<dd>
|
1651
2966
|
|
1652
|
-
**request:** `Airtop.
|
2967
|
+
**request:** `Airtop.LlmRequest`
|
1653
2968
|
|
1654
2969
|
</dd>
|
1655
2970
|
</dl>
|
@@ -1668,7 +2983,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1668
2983
|
</dl>
|
1669
2984
|
</details>
|
1670
2985
|
|
1671
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2986
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">waitForPage</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1672
2987
|
<dl>
|
1673
2988
|
<dd>
|
1674
2989
|
|
@@ -1680,7 +2995,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1680
2995
|
<dl>
|
1681
2996
|
<dd>
|
1682
2997
|
|
1683
|
-
|
2998
|
+
Wait for a page to load
|
1684
2999
|
|
1685
3000
|
</dd>
|
1686
3001
|
</dl>
|
@@ -1696,9 +3011,7 @@ Execute a type interaction in a specific browser window
|
|
1696
3011
|
<dd>
|
1697
3012
|
|
1698
3013
|
```typescript
|
1699
|
-
await client.windows.
|
1700
|
-
text: "Example text",
|
1701
|
-
});
|
3014
|
+
await client.windows.waitForPage("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1702
3015
|
```
|
1703
3016
|
|
1704
3017
|
</dd>
|
@@ -1730,7 +3043,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1730
3043
|
<dl>
|
1731
3044
|
<dd>
|
1732
3045
|
|
1733
|
-
**request:** `Airtop.
|
3046
|
+
**request:** `Airtop.WaitForPageRequest`
|
1734
3047
|
|
1735
3048
|
</dd>
|
1736
3049
|
</dl>
|