@airtop/sdk 0.1.42-beta0 → 0.1.43
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 +10 -9
- package/api/resources/automations/client/Client.js +4 -4
- package/api/resources/files/client/Client.js +5 -5
- 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 +7 -7
- package/api/resources/sessions/types/index.d.ts +2 -2
- package/api/resources/sessions/types/index.js +2 -2
- package/api/resources/windows/client/Client.d.ts +0 -224
- package/api/resources/windows/client/Client.js +220 -1175
- package/api/resources/windows/client/requests/index.d.ts +0 -17
- package/api/resources/windows/types/index.d.ts +0 -1
- package/api/resources/windows/types/index.js +0 -1
- package/api/types/index.d.ts +0 -1
- package/api/types/index.js +0 -1
- package/dist/api/resources/automations/client/Client.js +4 -4
- package/dist/api/resources/files/client/Client.js +5 -5
- 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 +7 -7
- package/dist/api/resources/sessions/types/index.d.ts +2 -2
- package/dist/api/resources/sessions/types/index.js +2 -2
- package/dist/api/resources/windows/client/Client.d.ts +0 -224
- package/dist/api/resources/windows/client/Client.js +220 -1175
- package/dist/api/resources/windows/client/requests/index.d.ts +0 -17
- package/dist/api/resources/windows/types/index.d.ts +0 -1
- package/dist/api/resources/windows/types/index.js +0 -1
- package/dist/api/types/index.d.ts +0 -1
- package/dist/api/types/index.js +0 -1
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +9 -9
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +4 -4
- package/dist/serialization/resources/sessions/types/index.d.ts +2 -2
- package/dist/serialization/resources/sessions/types/index.js +2 -2
- package/dist/serialization/resources/windows/client/requests/index.d.ts +0 -17
- package/dist/serialization/resources/windows/client/requests/index.js +1 -35
- package/dist/serialization/resources/windows/types/index.d.ts +0 -1
- package/dist/serialization/resources/windows/types/index.js +0 -1
- package/dist/serialization/types/index.d.ts +0 -1
- package/dist/serialization/types/index.js +0 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +140 -1449
- package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +9 -9
- package/serialization/resources/sessions/types/SessionsEventsResponse.js +4 -4
- package/serialization/resources/sessions/types/index.d.ts +2 -2
- package/serialization/resources/sessions/types/index.js +2 -2
- package/serialization/resources/windows/client/requests/index.d.ts +0 -17
- package/serialization/resources/windows/client/requests/index.js +1 -35
- package/serialization/resources/windows/types/index.d.ts +0 -1
- package/serialization/resources/windows/types/index.js +0 -1
- package/serialization/types/index.d.ts +0 -1
- package/serialization/types/index.js +0 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/windows/client/requests/ActRequest.d.ts +0 -30
- package/api/resources/windows/client/requests/ActRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
- package/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncFileInputRequest.d.ts +0 -33
- package/api/resources/windows/client/requests/AsyncFileInputRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
- package/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
- package/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
- package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
- package/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
- package/api/resources/windows/client/requests/ExtractRequest.d.ts +0 -30
- package/api/resources/windows/client/requests/ExtractRequest.js +0 -5
- package/api/resources/windows/client/requests/FindManyRequest.d.ts +0 -30
- package/api/resources/windows/client/requests/FindManyRequest.js +0 -5
- package/api/resources/windows/client/requests/FindOneRequest.d.ts +0 -30
- package/api/resources/windows/client/requests/FindOneRequest.js +0 -5
- package/api/resources/windows/client/requests/LlmRequest.d.ts +0 -25
- package/api/resources/windows/client/requests/LlmRequest.js +0 -5
- package/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -25
- package/api/resources/windows/client/requests/OperatorPromptV1Body.js +0 -5
- package/api/resources/windows/client/requests/WaitForPageRequest.d.ts +0 -23
- package/api/resources/windows/client/requests/WaitForPageRequest.js +0 -5
- package/api/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +0 -11
- package/api/resources/windows/types/WaitForPageRequestTargetStatus.js +0 -10
- package/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -9
- package/api/types/AsyncOperatorPromptResponseEnvelope.js +0 -5
- package/dist/api/resources/windows/client/requests/ActRequest.d.ts +0 -30
- package/dist/api/resources/windows/client/requests/ActRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -29
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncFileInputRequest.d.ts +0 -33
- package/dist/api/resources/windows/client/requests/AsyncFileInputRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -27
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -27
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -29
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -27
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -29
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -23
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -25
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -37
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/ExtractRequest.d.ts +0 -30
- package/dist/api/resources/windows/client/requests/ExtractRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/FindManyRequest.d.ts +0 -30
- package/dist/api/resources/windows/client/requests/FindManyRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/FindOneRequest.d.ts +0 -30
- package/dist/api/resources/windows/client/requests/FindOneRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/LlmRequest.d.ts +0 -25
- package/dist/api/resources/windows/client/requests/LlmRequest.js +0 -5
- package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -25
- package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.js +0 -5
- package/dist/api/resources/windows/client/requests/WaitForPageRequest.d.ts +0 -23
- package/dist/api/resources/windows/client/requests/WaitForPageRequest.js +0 -5
- package/dist/api/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +0 -11
- package/dist/api/resources/windows/types/WaitForPageRequestTargetStatus.js +0 -10
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -9
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.js +0 -5
- package/dist/serialization/resources/windows/client/requests/ActRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/ActRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -51
- package/dist/serialization/resources/windows/client/requests/AsyncFileInputRequest.d.ts +0 -23
- package/dist/serialization/resources/windows/client/requests/AsyncFileInputRequest.js +0 -54
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -51
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -51
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -49
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -55
- package/dist/serialization/resources/windows/client/requests/ExtractRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/ExtractRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/FindManyRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/FindManyRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/FindOneRequest.d.ts +0 -19
- package/dist/serialization/resources/windows/client/requests/FindOneRequest.js +0 -50
- package/dist/serialization/resources/windows/client/requests/LlmRequest.d.ts +0 -17
- package/dist/serialization/resources/windows/client/requests/LlmRequest.js +0 -48
- package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -17
- package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +0 -48
- package/dist/serialization/resources/windows/client/requests/WaitForPageRequest.d.ts +0 -18
- package/dist/serialization/resources/windows/client/requests/WaitForPageRequest.js +0 -49
- package/dist/serialization/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +0 -10
- package/dist/serialization/resources/windows/types/WaitForPageRequestTargetStatus.js +0 -41
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -15
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.js +0 -46
- package/serialization/resources/windows/client/requests/ActRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/ActRequest.js +0 -50
- package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +0 -20
- package/serialization/resources/windows/client/requests/AsyncClickRequest.js +0 -51
- package/serialization/resources/windows/client/requests/AsyncFileInputRequest.d.ts +0 -23
- package/serialization/resources/windows/client/requests/AsyncFileInputRequest.js +0 -54
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +0 -50
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +0 -50
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +0 -20
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +0 -51
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +0 -50
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +0 -20
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +0 -51
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +0 -18
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +0 -49
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +0 -50
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +0 -24
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +0 -55
- package/serialization/resources/windows/client/requests/ExtractRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/ExtractRequest.js +0 -50
- package/serialization/resources/windows/client/requests/FindManyRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/FindManyRequest.js +0 -50
- package/serialization/resources/windows/client/requests/FindOneRequest.d.ts +0 -19
- package/serialization/resources/windows/client/requests/FindOneRequest.js +0 -50
- package/serialization/resources/windows/client/requests/LlmRequest.d.ts +0 -17
- package/serialization/resources/windows/client/requests/LlmRequest.js +0 -48
- package/serialization/resources/windows/client/requests/OperatorPromptV1Body.d.ts +0 -17
- package/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +0 -48
- package/serialization/resources/windows/client/requests/WaitForPageRequest.d.ts +0 -18
- package/serialization/resources/windows/client/requests/WaitForPageRequest.js +0 -49
- package/serialization/resources/windows/types/WaitForPageRequestTargetStatus.d.ts +0 -10
- package/serialization/resources/windows/types/WaitForPageRequestTargetStatus.js +0 -41
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +0 -15
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.js +0 -46
package/reference.md
CHANGED
@@ -2,87 +2,6 @@
|
|
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
5
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
87
6
|
<dl>
|
88
7
|
<dd>
|
@@ -193,1220 +112,10 @@ Create a form filler automation asynchronously
|
|
193
112
|
<dd>
|
194
113
|
|
195
114
|
```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
|
-
|
1349
|
-
<dl>
|
1350
|
-
<dd>
|
1351
|
-
|
1352
|
-
**sessionId:** `string` — ID of the session that owns the window.
|
1353
|
-
|
1354
|
-
</dd>
|
1355
|
-
</dl>
|
1356
|
-
|
1357
|
-
<dl>
|
1358
|
-
<dd>
|
1359
|
-
|
1360
|
-
**windowId:** `string` — Airtop window ID of the browser window.
|
1361
|
-
|
1362
|
-
</dd>
|
1363
|
-
</dl>
|
1364
|
-
|
1365
|
-
<dl>
|
1366
|
-
<dd>
|
1367
|
-
|
1368
|
-
**requestOptions:** `Windows.RequestOptions`
|
1369
|
-
|
1370
|
-
</dd>
|
1371
|
-
</dl>
|
1372
|
-
</dd>
|
1373
|
-
</dl>
|
1374
|
-
|
1375
|
-
</dd>
|
1376
|
-
</dl>
|
1377
|
-
</details>
|
1378
|
-
|
1379
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1380
|
-
<dl>
|
1381
|
-
<dd>
|
1382
|
-
|
1383
|
-
#### 📝 Description
|
1384
|
-
|
1385
|
-
<dl>
|
1386
|
-
<dd>
|
1387
|
-
|
1388
|
-
<dl>
|
1389
|
-
<dd>
|
1390
|
-
|
1391
|
-
Execute a click interaction in a specific browser window
|
1392
|
-
|
1393
|
-
</dd>
|
1394
|
-
</dl>
|
1395
|
-
</dd>
|
1396
|
-
</dl>
|
1397
|
-
|
1398
|
-
#### 🔌 Usage
|
1399
|
-
|
1400
|
-
<dl>
|
1401
|
-
<dd>
|
1402
|
-
|
1403
|
-
<dl>
|
1404
|
-
<dd>
|
1405
|
-
|
1406
|
-
```typescript
|
1407
|
-
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1408
|
-
elementDescription: "The login button",
|
1409
|
-
});
|
115
|
+
await client.windows.asyncCreateFormFiller(
|
116
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
117
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
118
|
+
);
|
1410
119
|
```
|
1411
120
|
|
1412
121
|
</dd>
|
@@ -1438,7 +147,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1438
147
|
<dl>
|
1439
148
|
<dd>
|
1440
149
|
|
1441
|
-
**request:** `Airtop.
|
150
|
+
**request:** `Airtop.AsyncCreateFormFillerRequest`
|
1442
151
|
|
1443
152
|
</dd>
|
1444
153
|
</dl>
|
@@ -1457,7 +166,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1457
166
|
</dl>
|
1458
167
|
</details>
|
1459
168
|
|
1460
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
169
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1461
170
|
<dl>
|
1462
171
|
<dd>
|
1463
172
|
|
@@ -1469,7 +178,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1469
178
|
<dl>
|
1470
179
|
<dd>
|
1471
180
|
|
1472
|
-
|
181
|
+
Execute an automation of a browser window asynchronously
|
1473
182
|
|
1474
183
|
</dd>
|
1475
184
|
</dl>
|
@@ -1485,7 +194,13 @@ Create a form-filler automation synchronously for the form loaded in the browser
|
|
1485
194
|
<dd>
|
1486
195
|
|
1487
196
|
```typescript
|
1488
|
-
await client.windows.
|
197
|
+
await client.windows.asyncExecuteAutomation(
|
198
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
199
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
200
|
+
{
|
201
|
+
automationId: "automationId",
|
202
|
+
},
|
203
|
+
);
|
1489
204
|
```
|
1490
205
|
|
1491
206
|
</dd>
|
@@ -1517,7 +232,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1517
232
|
<dl>
|
1518
233
|
<dd>
|
1519
234
|
|
1520
|
-
**request:** `Airtop.
|
235
|
+
**request:** `Airtop.AsyncExecuteAutomationRequest`
|
1521
236
|
|
1522
237
|
</dd>
|
1523
238
|
</dl>
|
@@ -1536,7 +251,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1536
251
|
</dl>
|
1537
252
|
</details>
|
1538
253
|
|
1539
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
254
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
1540
255
|
<dl>
|
1541
256
|
<dd>
|
1542
257
|
|
@@ -1548,13 +263,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1548
263
|
<dl>
|
1549
264
|
<dd>
|
1550
265
|
|
1551
|
-
|
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.
|
266
|
+
Fill a form of a browser window asynchronously using a form-filler automation
|
1558
267
|
|
1559
268
|
</dd>
|
1560
269
|
</dl>
|
@@ -1570,7 +279,9 @@ will be used by AI to try to find a match visually.
|
|
1570
279
|
<dd>
|
1571
280
|
|
1572
281
|
```typescript
|
1573
|
-
await client.windows.
|
282
|
+
await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
283
|
+
automationId: "automationId",
|
284
|
+
});
|
1574
285
|
```
|
1575
286
|
|
1576
287
|
</dd>
|
@@ -1602,7 +313,7 @@ await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1602
313
|
<dl>
|
1603
314
|
<dd>
|
1604
315
|
|
1605
|
-
**request:** `Airtop.
|
316
|
+
**request:** `Airtop.AsyncFillFormRequest`
|
1606
317
|
|
1607
318
|
</dd>
|
1608
319
|
</dl>
|
@@ -1621,7 +332,7 @@ await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1621
332
|
</dl>
|
1622
333
|
</details>
|
1623
334
|
|
1624
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
335
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
1625
336
|
<dl>
|
1626
337
|
<dd>
|
1627
338
|
|
@@ -1633,7 +344,7 @@ await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1633
344
|
<dl>
|
1634
345
|
<dd>
|
1635
346
|
|
1636
|
-
|
347
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
1637
348
|
|
1638
349
|
</dd>
|
1639
350
|
</dl>
|
@@ -1649,9 +360,7 @@ Fill a form of a browser window synchronously using a form-filler automation
|
|
1649
360
|
<dd>
|
1650
361
|
|
1651
362
|
```typescript
|
1652
|
-
await client.windows.
|
1653
|
-
automationId: "automationId",
|
1654
|
-
});
|
363
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
1655
364
|
```
|
1656
365
|
|
1657
366
|
</dd>
|
@@ -1667,15 +376,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
1667
376
|
<dl>
|
1668
377
|
<dd>
|
1669
378
|
|
1670
|
-
**sessionId:** `string` —
|
1671
|
-
|
1672
|
-
</dd>
|
1673
|
-
</dl>
|
1674
|
-
|
1675
|
-
<dl>
|
1676
|
-
<dd>
|
1677
|
-
|
1678
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
379
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1679
380
|
|
1680
381
|
</dd>
|
1681
382
|
</dl>
|
@@ -1683,7 +384,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
1683
384
|
<dl>
|
1684
385
|
<dd>
|
1685
386
|
|
1686
|
-
**request:** `Airtop.
|
387
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
1687
388
|
|
1688
389
|
</dd>
|
1689
390
|
</dl>
|
@@ -1702,7 +403,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
1702
403
|
</dl>
|
1703
404
|
</details>
|
1704
405
|
|
1705
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
406
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
|
1706
407
|
<dl>
|
1707
408
|
<dd>
|
1708
409
|
|
@@ -1714,7 +415,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
1714
415
|
<dl>
|
1715
416
|
<dd>
|
1716
417
|
|
1717
|
-
|
418
|
+
Get information about a browser window in a session, including the live view url.
|
1718
419
|
|
1719
420
|
</dd>
|
1720
421
|
</dl>
|
@@ -1730,8 +431,8 @@ Execute a hover interaction in a specific browser window
|
|
1730
431
|
<dd>
|
1731
432
|
|
1732
433
|
```typescript
|
1733
|
-
await client.windows.
|
1734
|
-
|
434
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
435
|
+
screenResolution: "1280x720",
|
1735
436
|
});
|
1736
437
|
```
|
1737
438
|
|
@@ -1748,7 +449,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1748
449
|
<dl>
|
1749
450
|
<dd>
|
1750
451
|
|
1751
|
-
**sessionId:** `string` —
|
452
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1752
453
|
|
1753
454
|
</dd>
|
1754
455
|
</dl>
|
@@ -1756,7 +457,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1756
457
|
<dl>
|
1757
458
|
<dd>
|
1758
459
|
|
1759
|
-
**windowId:** `string` —
|
460
|
+
**windowId:** `string` — ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
|
1760
461
|
|
1761
462
|
</dd>
|
1762
463
|
</dl>
|
@@ -1764,7 +465,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1764
465
|
<dl>
|
1765
466
|
<dd>
|
1766
467
|
|
1767
|
-
**request:** `Airtop.
|
468
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
1768
469
|
|
1769
470
|
</dd>
|
1770
471
|
</dl>
|
@@ -1783,10 +484,25 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1783
484
|
</dl>
|
1784
485
|
</details>
|
1785
486
|
|
1786
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
487
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
488
|
+
<dl>
|
489
|
+
<dd>
|
490
|
+
|
491
|
+
#### 📝 Description
|
492
|
+
|
493
|
+
<dl>
|
494
|
+
<dd>
|
495
|
+
|
1787
496
|
<dl>
|
1788
497
|
<dd>
|
1789
498
|
|
499
|
+
Loads a specified url on a given window
|
500
|
+
|
501
|
+
</dd>
|
502
|
+
</dl>
|
503
|
+
</dd>
|
504
|
+
</dl>
|
505
|
+
|
1790
506
|
#### 🔌 Usage
|
1791
507
|
|
1792
508
|
<dl>
|
@@ -1796,8 +512,8 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
1796
512
|
<dd>
|
1797
513
|
|
1798
514
|
```typescript
|
1799
|
-
await client.windows.
|
1800
|
-
|
515
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
516
|
+
url: "https://www.airtop.ai",
|
1801
517
|
});
|
1802
518
|
```
|
1803
519
|
|
@@ -1814,7 +530,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1814
530
|
<dl>
|
1815
531
|
<dd>
|
1816
532
|
|
1817
|
-
**sessionId:** `string` —
|
533
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1818
534
|
|
1819
535
|
</dd>
|
1820
536
|
</dl>
|
@@ -1822,7 +538,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1822
538
|
<dl>
|
1823
539
|
<dd>
|
1824
540
|
|
1825
|
-
**windowId:** `string` —
|
541
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1826
542
|
|
1827
543
|
</dd>
|
1828
544
|
</dl>
|
@@ -1830,7 +546,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1830
546
|
<dl>
|
1831
547
|
<dd>
|
1832
548
|
|
1833
|
-
**request:** `Airtop.
|
549
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
1834
550
|
|
1835
551
|
</dd>
|
1836
552
|
</dl>
|
@@ -1849,7 +565,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1849
565
|
</dl>
|
1850
566
|
</details>
|
1851
567
|
|
1852
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
568
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
1853
569
|
<dl>
|
1854
570
|
<dd>
|
1855
571
|
|
@@ -1861,7 +577,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1861
577
|
<dl>
|
1862
578
|
<dd>
|
1863
579
|
|
1864
|
-
|
580
|
+
Closes a browser window in a session
|
1865
581
|
|
1866
582
|
</dd>
|
1867
583
|
</dl>
|
@@ -1877,9 +593,7 @@ Prompt OpenAI Operator
|
|
1877
593
|
<dd>
|
1878
594
|
|
1879
595
|
```typescript
|
1880
|
-
await client.windows.
|
1881
|
-
prompt: "What is the latest news about OpenAI?",
|
1882
|
-
});
|
596
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
1883
597
|
```
|
1884
598
|
|
1885
599
|
</dd>
|
@@ -1911,14 +625,6 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
|
|
1911
625
|
<dl>
|
1912
626
|
<dd>
|
1913
627
|
|
1914
|
-
**request:** `Airtop.OperatorPromptV1Body`
|
1915
|
-
|
1916
|
-
</dd>
|
1917
|
-
</dl>
|
1918
|
-
|
1919
|
-
<dl>
|
1920
|
-
<dd>
|
1921
|
-
|
1922
628
|
**requestOptions:** `Windows.RequestOptions`
|
1923
629
|
|
1924
630
|
</dd>
|
@@ -1930,7 +636,7 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
|
|
1930
636
|
</dl>
|
1931
637
|
</details>
|
1932
638
|
|
1933
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
639
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1934
640
|
<dl>
|
1935
641
|
<dd>
|
1936
642
|
|
@@ -1942,7 +648,7 @@ await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "733
|
|
1942
648
|
<dl>
|
1943
649
|
<dd>
|
1944
650
|
|
1945
|
-
|
651
|
+
Execute a click interaction in a specific browser window
|
1946
652
|
|
1947
653
|
</dd>
|
1948
654
|
</dl>
|
@@ -1958,8 +664,8 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
1958
664
|
<dd>
|
1959
665
|
|
1960
666
|
```typescript
|
1961
|
-
await client.windows.
|
1962
|
-
|
667
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
668
|
+
elementDescription: "The login button",
|
1963
669
|
});
|
1964
670
|
```
|
1965
671
|
|
@@ -1992,7 +698,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1992
698
|
<dl>
|
1993
699
|
<dd>
|
1994
700
|
|
1995
|
-
**request:** `Airtop.
|
701
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
1996
702
|
|
1997
703
|
</dd>
|
1998
704
|
</dl>
|
@@ -2011,7 +717,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
2011
717
|
</dl>
|
2012
718
|
</details>
|
2013
719
|
|
2014
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
720
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2015
721
|
<dl>
|
2016
722
|
<dd>
|
2017
723
|
|
@@ -2023,7 +729,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
2023
729
|
<dl>
|
2024
730
|
<dd>
|
2025
731
|
|
2026
|
-
|
732
|
+
Create a form-filler automation synchronously for the form loaded in the browser window
|
2027
733
|
|
2028
734
|
</dd>
|
2029
735
|
</dl>
|
@@ -2039,13 +745,7 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
2039
745
|
<dd>
|
2040
746
|
|
2041
747
|
```typescript
|
2042
|
-
await client.windows.
|
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
|
-
);
|
748
|
+
await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2049
749
|
```
|
2050
750
|
|
2051
751
|
</dd>
|
@@ -2077,7 +777,7 @@ await client.windows.paginatedExtraction(
|
|
2077
777
|
<dl>
|
2078
778
|
<dd>
|
2079
779
|
|
2080
|
-
**request:** `Airtop.
|
780
|
+
**request:** `Airtop.CreateFormFillerRequest`
|
2081
781
|
|
2082
782
|
</dd>
|
2083
783
|
</dl>
|
@@ -2096,7 +796,7 @@ await client.windows.paginatedExtraction(
|
|
2096
796
|
</dl>
|
2097
797
|
</details>
|
2098
798
|
|
2099
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
799
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fileInput</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2100
800
|
<dl>
|
2101
801
|
<dd>
|
2102
802
|
|
@@ -2108,7 +808,13 @@ await client.windows.paginatedExtraction(
|
|
2108
808
|
<dl>
|
2109
809
|
<dd>
|
2110
810
|
|
2111
|
-
|
811
|
+
Execute a file input interaction in a specific browser window.
|
812
|
+
includeHiddenElements defaults to true and considers hidden file input elements.
|
813
|
+
If there is only one file input element, it will be used directly.
|
814
|
+
If there are multiple file input elements, the elementDescription will be used by AI to
|
815
|
+
select among them.
|
816
|
+
If no file input elements are found by inspecting the page structure, elementDescription
|
817
|
+
will be used by AI to try to find a match visually.
|
2112
818
|
|
2113
819
|
</dd>
|
2114
820
|
</dl>
|
@@ -2124,9 +830,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
2124
830
|
<dd>
|
2125
831
|
|
2126
832
|
```typescript
|
2127
|
-
await client.windows.
|
2128
|
-
prompt: "What is the main idea of this page?",
|
2129
|
-
});
|
833
|
+
await client.windows.fileInput("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2130
834
|
```
|
2131
835
|
|
2132
836
|
</dd>
|
@@ -2158,7 +862,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
2158
862
|
<dl>
|
2159
863
|
<dd>
|
2160
864
|
|
2161
|
-
**request:** `Airtop.
|
865
|
+
**request:** `Airtop.SessionFileInputHandlerRequestBody`
|
2162
866
|
|
2163
867
|
</dd>
|
2164
868
|
</dl>
|
@@ -2177,7 +881,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
2177
881
|
</dl>
|
2178
882
|
</details>
|
2179
883
|
|
2180
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
884
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2181
885
|
<dl>
|
2182
886
|
<dd>
|
2183
887
|
|
@@ -2189,7 +893,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
2189
893
|
<dl>
|
2190
894
|
<dd>
|
2191
895
|
|
2192
|
-
|
896
|
+
Fill a form of a browser window synchronously using a form-filler automation
|
2193
897
|
|
2194
898
|
</dd>
|
2195
899
|
</dl>
|
@@ -2205,7 +909,9 @@ Scrape a window and return the content as markdown
|
|
2205
909
|
<dd>
|
2206
910
|
|
2207
911
|
```typescript
|
2208
|
-
await client.windows.
|
912
|
+
await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
913
|
+
automationId: "automationId",
|
914
|
+
});
|
2209
915
|
```
|
2210
916
|
|
2211
917
|
</dd>
|
@@ -2229,7 +935,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
2229
935
|
<dl>
|
2230
936
|
<dd>
|
2231
937
|
|
2232
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
938
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
2233
939
|
|
2234
940
|
</dd>
|
2235
941
|
</dl>
|
@@ -2237,7 +943,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
2237
943
|
<dl>
|
2238
944
|
<dd>
|
2239
945
|
|
2240
|
-
**request:** `Airtop.
|
946
|
+
**request:** `Airtop.FillFormRequest`
|
2241
947
|
|
2242
948
|
</dd>
|
2243
949
|
</dl>
|
@@ -2256,7 +962,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
2256
962
|
</dl>
|
2257
963
|
</details>
|
2258
964
|
|
2259
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
965
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2260
966
|
<dl>
|
2261
967
|
<dd>
|
2262
968
|
|
@@ -2268,7 +974,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
2268
974
|
<dl>
|
2269
975
|
<dd>
|
2270
976
|
|
2271
|
-
|
977
|
+
Execute a hover interaction in a specific browser window
|
2272
978
|
|
2273
979
|
</dd>
|
2274
980
|
</dl>
|
@@ -2284,7 +990,9 @@ Take a screenshot of a browser window
|
|
2284
990
|
<dd>
|
2285
991
|
|
2286
992
|
```typescript
|
2287
|
-
await client.windows.
|
993
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
994
|
+
elementDescription: "The search box input in the top right corner",
|
995
|
+
});
|
2288
996
|
```
|
2289
997
|
|
2290
998
|
</dd>
|
@@ -2316,7 +1024,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
2316
1024
|
<dl>
|
2317
1025
|
<dd>
|
2318
1026
|
|
2319
|
-
**request:** `Airtop.
|
1027
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
2320
1028
|
|
2321
1029
|
</dd>
|
2322
1030
|
</dl>
|
@@ -2335,25 +1043,10 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
2335
1043
|
</dl>
|
2336
1044
|
</details>
|
2337
1045
|
|
2338
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
2339
|
-
<dl>
|
2340
|
-
<dd>
|
2341
|
-
|
2342
|
-
#### 📝 Description
|
2343
|
-
|
2344
|
-
<dl>
|
2345
|
-
<dd>
|
2346
|
-
|
1046
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2347
1047
|
<dl>
|
2348
1048
|
<dd>
|
2349
1049
|
|
2350
|
-
Execute a scroll interaction in a specific browser window
|
2351
|
-
|
2352
|
-
</dd>
|
2353
|
-
</dl>
|
2354
|
-
</dd>
|
2355
|
-
</dl>
|
2356
|
-
|
2357
1050
|
#### 🔌 Usage
|
2358
1051
|
|
2359
1052
|
<dl>
|
@@ -2363,7 +1056,9 @@ Execute a scroll interaction in a specific browser window
|
|
2363
1056
|
<dd>
|
2364
1057
|
|
2365
1058
|
```typescript
|
2366
|
-
await client.windows.
|
1059
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1060
|
+
condition: "Determine if the user appears to be signed in to the website",
|
1061
|
+
});
|
2367
1062
|
```
|
2368
1063
|
|
2369
1064
|
</dd>
|
@@ -2395,7 +1090,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
2395
1090
|
<dl>
|
2396
1091
|
<dd>
|
2397
1092
|
|
2398
|
-
**request:** `Airtop.
|
1093
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
2399
1094
|
|
2400
1095
|
</dd>
|
2401
1096
|
</dl>
|
@@ -2414,7 +1109,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
2414
1109
|
</dl>
|
2415
1110
|
</details>
|
2416
1111
|
|
2417
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1112
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2418
1113
|
<dl>
|
2419
1114
|
<dd>
|
2420
1115
|
|
@@ -2426,7 +1121,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
2426
1121
|
<dl>
|
2427
1122
|
<dd>
|
2428
1123
|
|
2429
|
-
|
1124
|
+
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?).
|
2430
1125
|
|
2431
1126
|
</dd>
|
2432
1127
|
</dl>
|
@@ -2442,7 +1137,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
2442
1137
|
<dd>
|
2443
1138
|
|
2444
1139
|
```typescript
|
2445
|
-
await client.windows.
|
1140
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1141
|
+
prompt: "What is the main idea of this page?",
|
1142
|
+
});
|
2446
1143
|
```
|
2447
1144
|
|
2448
1145
|
</dd>
|
@@ -2466,7 +1163,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
2466
1163
|
<dl>
|
2467
1164
|
<dd>
|
2468
1165
|
|
2469
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
1166
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
2470
1167
|
|
2471
1168
|
</dd>
|
2472
1169
|
</dl>
|
@@ -2474,7 +1171,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
2474
1171
|
<dl>
|
2475
1172
|
<dd>
|
2476
1173
|
|
2477
|
-
**request:** `Airtop.
|
1174
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
2478
1175
|
|
2479
1176
|
</dd>
|
2480
1177
|
</dl>
|
@@ -2493,7 +1190,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
2493
1190
|
</dl>
|
2494
1191
|
</details>
|
2495
1192
|
|
2496
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1193
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2497
1194
|
<dl>
|
2498
1195
|
<dd>
|
2499
1196
|
|
@@ -2505,7 +1202,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
2505
1202
|
<dl>
|
2506
1203
|
<dd>
|
2507
1204
|
|
2508
|
-
|
1205
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
2509
1206
|
|
2510
1207
|
</dd>
|
2511
1208
|
</dl>
|
@@ -2521,9 +1218,13 @@ Execute a type interaction in a specific browser window
|
|
2521
1218
|
<dd>
|
2522
1219
|
|
2523
1220
|
```typescript
|
2524
|
-
await client.windows.
|
2525
|
-
|
2526
|
-
|
1221
|
+
await client.windows.paginatedExtraction(
|
1222
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1223
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
1224
|
+
{
|
1225
|
+
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.",
|
1226
|
+
},
|
1227
|
+
);
|
2527
1228
|
```
|
2528
1229
|
|
2529
1230
|
</dd>
|
@@ -2555,7 +1256,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
2555
1256
|
<dl>
|
2556
1257
|
<dd>
|
2557
1258
|
|
2558
|
-
**request:** `Airtop.
|
1259
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
2559
1260
|
|
2560
1261
|
</dd>
|
2561
1262
|
</dl>
|
@@ -2574,7 +1275,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
2574
1275
|
</dl>
|
2575
1276
|
</details>
|
2576
1277
|
|
2577
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1278
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2578
1279
|
<dl>
|
2579
1280
|
<dd>
|
2580
1281
|
|
@@ -2586,7 +1287,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
2586
1287
|
<dl>
|
2587
1288
|
<dd>
|
2588
1289
|
|
2589
|
-
|
1290
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
2590
1291
|
|
2591
1292
|
</dd>
|
2592
1293
|
</dl>
|
@@ -2602,9 +1303,8 @@ Perform actions in a specific browser window based on a prompt
|
|
2602
1303
|
<dd>
|
2603
1304
|
|
2604
1305
|
```typescript
|
2605
|
-
await client.windows.
|
2606
|
-
|
2607
|
-
prompt: "Click the login button",
|
1306
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1307
|
+
prompt: "What is the main idea of this page?",
|
2608
1308
|
});
|
2609
1309
|
```
|
2610
1310
|
|
@@ -2637,7 +1337,7 @@ await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
|
|
2637
1337
|
<dl>
|
2638
1338
|
<dd>
|
2639
1339
|
|
2640
|
-
**request:** `Airtop.
|
1340
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
2641
1341
|
|
2642
1342
|
</dd>
|
2643
1343
|
</dl>
|
@@ -2656,7 +1356,7 @@ await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
|
|
2656
1356
|
</dl>
|
2657
1357
|
</details>
|
2658
1358
|
|
2659
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1359
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
2660
1360
|
<dl>
|
2661
1361
|
<dd>
|
2662
1362
|
|
@@ -2668,7 +1368,7 @@ await client.windows.act("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
|
|
2668
1368
|
<dl>
|
2669
1369
|
<dd>
|
2670
1370
|
|
2671
|
-
|
1371
|
+
Scrape a window and return the content as markdown
|
2672
1372
|
|
2673
1373
|
</dd>
|
2674
1374
|
</dl>
|
@@ -2684,10 +1384,7 @@ Extract data from a specific browser window based on a prompt
|
|
2684
1384
|
<dd>
|
2685
1385
|
|
2686
1386
|
```typescript
|
2687
|
-
await client.windows.
|
2688
|
-
jobId: "123",
|
2689
|
-
prompt: "Extract all product prices from this page",
|
2690
|
-
});
|
1387
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2691
1388
|
```
|
2692
1389
|
|
2693
1390
|
</dd>
|
@@ -2711,7 +1408,7 @@ await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
2711
1408
|
<dl>
|
2712
1409
|
<dd>
|
2713
1410
|
|
2714
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
1411
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
2715
1412
|
|
2716
1413
|
</dd>
|
2717
1414
|
</dl>
|
@@ -2719,7 +1416,7 @@ await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
2719
1416
|
<dl>
|
2720
1417
|
<dd>
|
2721
1418
|
|
2722
|
-
**request:** `Airtop.
|
1419
|
+
**request:** `Airtop.ScrapeContentRequest`
|
2723
1420
|
|
2724
1421
|
</dd>
|
2725
1422
|
</dl>
|
@@ -2738,7 +1435,7 @@ await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
2738
1435
|
</dl>
|
2739
1436
|
</details>
|
2740
1437
|
|
2741
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1438
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2742
1439
|
<dl>
|
2743
1440
|
<dd>
|
2744
1441
|
|
@@ -2750,7 +1447,7 @@ await client.windows.extract("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
2750
1447
|
<dl>
|
2751
1448
|
<dd>
|
2752
1449
|
|
2753
|
-
|
1450
|
+
Take a screenshot of a browser window
|
2754
1451
|
|
2755
1452
|
</dd>
|
2756
1453
|
</dl>
|
@@ -2766,10 +1463,7 @@ Find multiple elements in a browser window based on a prompt
|
|
2766
1463
|
<dd>
|
2767
1464
|
|
2768
1465
|
```typescript
|
2769
|
-
await client.windows.
|
2770
|
-
jobId: "123",
|
2771
|
-
prompt: "Find all the news articles",
|
2772
|
-
});
|
1466
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2773
1467
|
```
|
2774
1468
|
|
2775
1469
|
</dd>
|
@@ -2801,7 +1495,7 @@ await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
2801
1495
|
<dl>
|
2802
1496
|
<dd>
|
2803
1497
|
|
2804
|
-
**request:** `Airtop.
|
1498
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
2805
1499
|
|
2806
1500
|
</dd>
|
2807
1501
|
</dl>
|
@@ -2820,7 +1514,7 @@ await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
2820
1514
|
</dl>
|
2821
1515
|
</details>
|
2822
1516
|
|
2823
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1517
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2824
1518
|
<dl>
|
2825
1519
|
<dd>
|
2826
1520
|
|
@@ -2832,7 +1526,7 @@ await client.windows.findMany("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
2832
1526
|
<dl>
|
2833
1527
|
<dd>
|
2834
1528
|
|
2835
|
-
|
1529
|
+
Execute a scroll interaction in a specific browser window
|
2836
1530
|
|
2837
1531
|
</dd>
|
2838
1532
|
</dl>
|
@@ -2848,10 +1542,7 @@ Find a specific element in a browser window based on a prompt
|
|
2848
1542
|
<dd>
|
2849
1543
|
|
2850
1544
|
```typescript
|
2851
|
-
await client.windows.
|
2852
|
-
jobId: "123",
|
2853
|
-
prompt: "Find the login button",
|
2854
|
-
});
|
1545
|
+
await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2855
1546
|
```
|
2856
1547
|
|
2857
1548
|
</dd>
|
@@ -2883,7 +1574,7 @@ await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
2883
1574
|
<dl>
|
2884
1575
|
<dd>
|
2885
1576
|
|
2886
|
-
**request:** `Airtop.
|
1577
|
+
**request:** `Airtop.SessionScrollHandlerRequestBody`
|
2887
1578
|
|
2888
1579
|
</dd>
|
2889
1580
|
</dl>
|
@@ -2902,7 +1593,7 @@ await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
2902
1593
|
</dl>
|
2903
1594
|
</details>
|
2904
1595
|
|
2905
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1596
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2906
1597
|
<dl>
|
2907
1598
|
<dd>
|
2908
1599
|
|
@@ -2914,7 +1605,7 @@ await client.windows.findOne("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
2914
1605
|
<dl>
|
2915
1606
|
<dd>
|
2916
1607
|
|
2917
|
-
|
1608
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
2918
1609
|
|
2919
1610
|
</dd>
|
2920
1611
|
</dl>
|
@@ -2930,9 +1621,7 @@ Send a prompt to an LLM with context from the browser window
|
|
2930
1621
|
<dd>
|
2931
1622
|
|
2932
1623
|
```typescript
|
2933
|
-
await client.windows.
|
2934
|
-
prompt: "Tell me about this webpage",
|
2935
|
-
});
|
1624
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2936
1625
|
```
|
2937
1626
|
|
2938
1627
|
</dd>
|
@@ -2956,7 +1645,7 @@ await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
|
|
2956
1645
|
<dl>
|
2957
1646
|
<dd>
|
2958
1647
|
|
2959
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
1648
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
2960
1649
|
|
2961
1650
|
</dd>
|
2962
1651
|
</dl>
|
@@ -2964,7 +1653,7 @@ await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
|
|
2964
1653
|
<dl>
|
2965
1654
|
<dd>
|
2966
1655
|
|
2967
|
-
**request:** `Airtop.
|
1656
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
2968
1657
|
|
2969
1658
|
</dd>
|
2970
1659
|
</dl>
|
@@ -2983,7 +1672,7 @@ await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
|
|
2983
1672
|
</dl>
|
2984
1673
|
</details>
|
2985
1674
|
|
2986
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1675
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2987
1676
|
<dl>
|
2988
1677
|
<dd>
|
2989
1678
|
|
@@ -2995,7 +1684,7 @@ await client.windows.llm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-
|
|
2995
1684
|
<dl>
|
2996
1685
|
<dd>
|
2997
1686
|
|
2998
|
-
|
1687
|
+
Execute a type interaction in a specific browser window
|
2999
1688
|
|
3000
1689
|
</dd>
|
3001
1690
|
</dl>
|
@@ -3011,7 +1700,9 @@ Wait for a page to load
|
|
3011
1700
|
<dd>
|
3012
1701
|
|
3013
1702
|
```typescript
|
3014
|
-
await client.windows.
|
1703
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1704
|
+
text: "Example text",
|
1705
|
+
});
|
3015
1706
|
```
|
3016
1707
|
|
3017
1708
|
</dd>
|
@@ -3043,7 +1734,7 @@ await client.windows.waitForPage("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da
|
|
3043
1734
|
<dl>
|
3044
1735
|
<dd>
|
3045
1736
|
|
3046
|
-
**request:** `Airtop.
|
1737
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
3047
1738
|
|
3048
1739
|
</dd>
|
3049
1740
|
</dl>
|