airbrowser-client 1.13.1 → 1.14.0
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/.openapi-generator/FILES +6 -0
- package/README.md +11 -5
- package/api.ts +867 -464
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +383 -35
- package/dist/api.js +150 -24
- package/dist/esm/api.d.ts +383 -35
- package/dist/esm/api.js +149 -23
- package/docs/BrowserApi.md +72 -12
- package/docs/DetectCoordinatesData.md +48 -0
- package/docs/DetectCoordinatesRequest.md +15 -3
- package/docs/DetectCoordinatesResult.md +24 -0
- package/docs/GuiClickData.md +44 -0
- package/docs/GuiClickRequest.md +22 -6
- package/docs/GuiClickResult.md +24 -0
- package/docs/GuiClickXYRequest.md +40 -0
- package/docs/HealthApi.md +0 -1
- package/docs/PoolApi.md +0 -1
- package/docs/ProfilesApi.md +0 -1
- package/docs/WhatIsVisibleRequest.md +22 -0
- package/index.ts +1 -2
- package/package.json +1 -1
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -154,19 +154,131 @@ export interface CreateProfileRequest {
|
|
|
154
154
|
*/
|
|
155
155
|
'name': string;
|
|
156
156
|
}
|
|
157
|
+
export interface DetectCoordinatesData {
|
|
158
|
+
/**
|
|
159
|
+
* Element description used
|
|
160
|
+
*/
|
|
161
|
+
'prompt'?: string;
|
|
162
|
+
/**
|
|
163
|
+
* Element bounding box {x, y, width, height}
|
|
164
|
+
*/
|
|
165
|
+
'bounding_box'?: object;
|
|
166
|
+
/**
|
|
167
|
+
* Recommended click point {x, y}
|
|
168
|
+
*/
|
|
169
|
+
'click_point'?: object;
|
|
170
|
+
/**
|
|
171
|
+
* Detection confidence (0.0-1.0)
|
|
172
|
+
*/
|
|
173
|
+
'confidence'?: number;
|
|
174
|
+
/**
|
|
175
|
+
* Machine-readable detect outcome status
|
|
176
|
+
*/
|
|
177
|
+
'outcome_status'?: string;
|
|
178
|
+
/**
|
|
179
|
+
* Machine-readable detect reason code
|
|
180
|
+
*/
|
|
181
|
+
'reason'?: string;
|
|
182
|
+
/**
|
|
183
|
+
* Human-readable reason detail
|
|
184
|
+
*/
|
|
185
|
+
'reason_detail'?: string;
|
|
186
|
+
/**
|
|
187
|
+
* Resolved target details after validation or snapping
|
|
188
|
+
*/
|
|
189
|
+
'resolved_target'?: object;
|
|
190
|
+
/**
|
|
191
|
+
* Validated or snapped click point {x, y}
|
|
192
|
+
*/
|
|
193
|
+
'resolved_click_point'?: object;
|
|
194
|
+
/**
|
|
195
|
+
* Details about any snap candidate that was applied
|
|
196
|
+
*/
|
|
197
|
+
'snap_result'?: object;
|
|
198
|
+
/**
|
|
199
|
+
* Suggested next action for callers
|
|
200
|
+
*/
|
|
201
|
+
'recommended_next_action'?: string;
|
|
202
|
+
/**
|
|
203
|
+
* URL to the screenshot
|
|
204
|
+
*/
|
|
205
|
+
'screenshot_url'?: string;
|
|
206
|
+
/**
|
|
207
|
+
* Original screenshot dimensions
|
|
208
|
+
*/
|
|
209
|
+
'image_size'?: object;
|
|
210
|
+
/**
|
|
211
|
+
* Coordinate transform metadata
|
|
212
|
+
*/
|
|
213
|
+
'transform_info'?: object;
|
|
214
|
+
/**
|
|
215
|
+
* Optional smart-targeting debug details
|
|
216
|
+
*/
|
|
217
|
+
'debug'?: object;
|
|
218
|
+
}
|
|
157
219
|
export interface DetectCoordinatesRequest {
|
|
158
220
|
/**
|
|
159
|
-
*
|
|
221
|
+
* Natural language description of element to find
|
|
160
222
|
*/
|
|
161
223
|
'prompt': string;
|
|
162
224
|
/**
|
|
163
|
-
*
|
|
225
|
+
* Relative X (0..1) within the detected element
|
|
164
226
|
*/
|
|
165
227
|
'fx'?: number;
|
|
166
228
|
/**
|
|
167
|
-
*
|
|
229
|
+
* Relative Y (0..1) within the detected element
|
|
168
230
|
*/
|
|
169
231
|
'fy'?: number;
|
|
232
|
+
/**
|
|
233
|
+
* Optional vision model override for this request
|
|
234
|
+
*/
|
|
235
|
+
'model'?: string;
|
|
236
|
+
/**
|
|
237
|
+
* Optional vision streaming override for this request
|
|
238
|
+
*/
|
|
239
|
+
'stream'?: boolean;
|
|
240
|
+
/**
|
|
241
|
+
* Detect-time validation mode
|
|
242
|
+
*/
|
|
243
|
+
'hit_test'?: DetectCoordinatesRequestHitTestEnum;
|
|
244
|
+
/**
|
|
245
|
+
* Auto-snap mode for nearby targets
|
|
246
|
+
*/
|
|
247
|
+
'auto_snap'?: DetectCoordinatesRequestAutoSnapEnum;
|
|
248
|
+
/**
|
|
249
|
+
* Maximum snap radius in CSS pixels
|
|
250
|
+
*/
|
|
251
|
+
'snap_radius'?: number;
|
|
252
|
+
/**
|
|
253
|
+
* Include smart-targeting debug details
|
|
254
|
+
*/
|
|
255
|
+
'include_debug'?: boolean;
|
|
256
|
+
}
|
|
257
|
+
export declare const DetectCoordinatesRequestHitTestEnum: {
|
|
258
|
+
readonly Off: "off";
|
|
259
|
+
readonly Warn: "warn";
|
|
260
|
+
readonly Strict: "strict";
|
|
261
|
+
};
|
|
262
|
+
export type DetectCoordinatesRequestHitTestEnum = typeof DetectCoordinatesRequestHitTestEnum[keyof typeof DetectCoordinatesRequestHitTestEnum];
|
|
263
|
+
export declare const DetectCoordinatesRequestAutoSnapEnum: {
|
|
264
|
+
readonly Off: "off";
|
|
265
|
+
readonly NearestClickable: "nearest_clickable";
|
|
266
|
+
readonly NearestInteractive: "nearest_interactive";
|
|
267
|
+
};
|
|
268
|
+
export type DetectCoordinatesRequestAutoSnapEnum = typeof DetectCoordinatesRequestAutoSnapEnum[keyof typeof DetectCoordinatesRequestAutoSnapEnum];
|
|
269
|
+
export interface DetectCoordinatesResult {
|
|
270
|
+
/**
|
|
271
|
+
* Operation success
|
|
272
|
+
*/
|
|
273
|
+
'success'?: boolean;
|
|
274
|
+
/**
|
|
275
|
+
* Success message
|
|
276
|
+
*/
|
|
277
|
+
'message'?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Detect response payload
|
|
280
|
+
*/
|
|
281
|
+
'data'?: DetectCoordinatesData;
|
|
170
282
|
}
|
|
171
283
|
export interface DialogRequest {
|
|
172
284
|
/**
|
|
@@ -274,32 +386,218 @@ export interface GenericResponse {
|
|
|
274
386
|
*/
|
|
275
387
|
'data'?: object;
|
|
276
388
|
}
|
|
389
|
+
export interface GuiClickData {
|
|
390
|
+
/**
|
|
391
|
+
* Legacy inner status
|
|
392
|
+
*/
|
|
393
|
+
'status'?: string;
|
|
394
|
+
/**
|
|
395
|
+
* Legacy inner success flag
|
|
396
|
+
*/
|
|
397
|
+
'success'?: boolean;
|
|
398
|
+
/**
|
|
399
|
+
* Legacy inner message
|
|
400
|
+
*/
|
|
401
|
+
'message'?: string;
|
|
402
|
+
/**
|
|
403
|
+
* Requested or resolved screen X coordinate
|
|
404
|
+
*/
|
|
405
|
+
'x'?: number;
|
|
406
|
+
/**
|
|
407
|
+
* Requested or resolved screen Y coordinate
|
|
408
|
+
*/
|
|
409
|
+
'y'?: number;
|
|
410
|
+
/**
|
|
411
|
+
* Machine-readable click outcome status
|
|
412
|
+
*/
|
|
413
|
+
'outcome_status'?: string;
|
|
414
|
+
/**
|
|
415
|
+
* Machine-readable click reason code
|
|
416
|
+
*/
|
|
417
|
+
'reason'?: string;
|
|
418
|
+
/**
|
|
419
|
+
* Human-readable reason detail
|
|
420
|
+
*/
|
|
421
|
+
'reason_detail'?: string;
|
|
422
|
+
/**
|
|
423
|
+
* Pre-click validation details
|
|
424
|
+
*/
|
|
425
|
+
'precheck'?: object;
|
|
426
|
+
/**
|
|
427
|
+
* Click execution details
|
|
428
|
+
*/
|
|
429
|
+
'execution'?: object;
|
|
430
|
+
/**
|
|
431
|
+
* Post-click feedback details
|
|
432
|
+
*/
|
|
433
|
+
'postcheck'?: object;
|
|
434
|
+
/**
|
|
435
|
+
* Suggested next action for callers
|
|
436
|
+
*/
|
|
437
|
+
'recommended_next_action'?: string;
|
|
438
|
+
/**
|
|
439
|
+
* Optional smart-click debug details
|
|
440
|
+
*/
|
|
441
|
+
'debug'?: object;
|
|
442
|
+
}
|
|
277
443
|
export interface GuiClickRequest {
|
|
278
444
|
/**
|
|
279
|
-
* selector
|
|
445
|
+
* Element selector (CSS or XPath)
|
|
280
446
|
*/
|
|
281
447
|
'selector'?: string;
|
|
282
448
|
/**
|
|
283
|
-
*
|
|
449
|
+
* Screen X coordinate (coordinate mode)
|
|
284
450
|
*/
|
|
285
451
|
'x'?: number;
|
|
286
452
|
/**
|
|
287
|
-
*
|
|
453
|
+
* Screen Y coordinate (coordinate mode)
|
|
288
454
|
*/
|
|
289
455
|
'y'?: number;
|
|
290
456
|
/**
|
|
291
|
-
*
|
|
457
|
+
* Mouse move duration (seconds)
|
|
292
458
|
*/
|
|
293
459
|
'timeframe'?: number;
|
|
294
460
|
/**
|
|
295
|
-
*
|
|
461
|
+
* Relative X (0..1) within element to click
|
|
296
462
|
*/
|
|
297
463
|
'fx'?: number;
|
|
298
464
|
/**
|
|
299
|
-
*
|
|
465
|
+
* Relative Y (0..1) within element to click
|
|
300
466
|
*/
|
|
301
467
|
'fy'?: number;
|
|
468
|
+
/**
|
|
469
|
+
* Pre-click validation mode
|
|
470
|
+
*/
|
|
471
|
+
'pre_click_validate'?: GuiClickRequestPreClickValidateEnum;
|
|
472
|
+
/**
|
|
473
|
+
* Auto-snap mode for nearby targets
|
|
474
|
+
*/
|
|
475
|
+
'auto_snap'?: GuiClickRequestAutoSnapEnum;
|
|
476
|
+
/**
|
|
477
|
+
* Maximum snap radius in CSS pixels
|
|
478
|
+
*/
|
|
479
|
+
'snap_radius'?: number;
|
|
480
|
+
/**
|
|
481
|
+
* Post-click feedback mode
|
|
482
|
+
*/
|
|
483
|
+
'post_click_feedback'?: GuiClickRequestPostClickFeedbackEnum;
|
|
484
|
+
/**
|
|
485
|
+
* Post-click observation timeout in milliseconds
|
|
486
|
+
*/
|
|
487
|
+
'post_click_timeout_ms'?: number;
|
|
488
|
+
/**
|
|
489
|
+
* Include truncated content in post-click feedback
|
|
490
|
+
*/
|
|
491
|
+
'return_content'?: boolean;
|
|
492
|
+
/**
|
|
493
|
+
* Maximum returned content length
|
|
494
|
+
*/
|
|
495
|
+
'content_limit_chars'?: number;
|
|
496
|
+
/**
|
|
497
|
+
* Include smart-click debug diagnostics
|
|
498
|
+
*/
|
|
499
|
+
'include_debug'?: boolean;
|
|
500
|
+
}
|
|
501
|
+
export declare const GuiClickRequestPreClickValidateEnum: {
|
|
502
|
+
readonly Off: "off";
|
|
503
|
+
readonly Warn: "warn";
|
|
504
|
+
readonly Strict: "strict";
|
|
505
|
+
};
|
|
506
|
+
export type GuiClickRequestPreClickValidateEnum = typeof GuiClickRequestPreClickValidateEnum[keyof typeof GuiClickRequestPreClickValidateEnum];
|
|
507
|
+
export declare const GuiClickRequestAutoSnapEnum: {
|
|
508
|
+
readonly Off: "off";
|
|
509
|
+
readonly NearestClickable: "nearest_clickable";
|
|
510
|
+
readonly NearestInteractive: "nearest_interactive";
|
|
511
|
+
};
|
|
512
|
+
export type GuiClickRequestAutoSnapEnum = typeof GuiClickRequestAutoSnapEnum[keyof typeof GuiClickRequestAutoSnapEnum];
|
|
513
|
+
export declare const GuiClickRequestPostClickFeedbackEnum: {
|
|
514
|
+
readonly None: "none";
|
|
515
|
+
readonly Url: "url";
|
|
516
|
+
readonly Content: "content";
|
|
517
|
+
readonly Visible: "visible";
|
|
518
|
+
readonly Auto: "auto";
|
|
519
|
+
};
|
|
520
|
+
export type GuiClickRequestPostClickFeedbackEnum = typeof GuiClickRequestPostClickFeedbackEnum[keyof typeof GuiClickRequestPostClickFeedbackEnum];
|
|
521
|
+
export interface GuiClickResult {
|
|
522
|
+
/**
|
|
523
|
+
* Operation success
|
|
524
|
+
*/
|
|
525
|
+
'success'?: boolean;
|
|
526
|
+
/**
|
|
527
|
+
* Success message
|
|
528
|
+
*/
|
|
529
|
+
'message'?: string;
|
|
530
|
+
/**
|
|
531
|
+
* GUI click response payload
|
|
532
|
+
*/
|
|
533
|
+
'data'?: GuiClickData;
|
|
534
|
+
}
|
|
535
|
+
export interface GuiClickXYRequest {
|
|
536
|
+
/**
|
|
537
|
+
* Screen X coordinate
|
|
538
|
+
*/
|
|
539
|
+
'x': number;
|
|
540
|
+
/**
|
|
541
|
+
* Screen Y coordinate
|
|
542
|
+
*/
|
|
543
|
+
'y': number;
|
|
544
|
+
/**
|
|
545
|
+
* Mouse move duration (seconds)
|
|
546
|
+
*/
|
|
547
|
+
'timeframe'?: number;
|
|
548
|
+
/**
|
|
549
|
+
* Pre-click validation mode
|
|
550
|
+
*/
|
|
551
|
+
'pre_click_validate'?: GuiClickXYRequestPreClickValidateEnum;
|
|
552
|
+
/**
|
|
553
|
+
* Auto-snap mode for nearby targets
|
|
554
|
+
*/
|
|
555
|
+
'auto_snap'?: GuiClickXYRequestAutoSnapEnum;
|
|
556
|
+
/**
|
|
557
|
+
* Maximum snap radius in CSS pixels
|
|
558
|
+
*/
|
|
559
|
+
'snap_radius'?: number;
|
|
560
|
+
/**
|
|
561
|
+
* Post-click feedback mode
|
|
562
|
+
*/
|
|
563
|
+
'post_click_feedback'?: GuiClickXYRequestPostClickFeedbackEnum;
|
|
564
|
+
/**
|
|
565
|
+
* Post-click observation timeout in milliseconds
|
|
566
|
+
*/
|
|
567
|
+
'post_click_timeout_ms'?: number;
|
|
568
|
+
/**
|
|
569
|
+
* Include truncated content in post-click feedback
|
|
570
|
+
*/
|
|
571
|
+
'return_content'?: boolean;
|
|
572
|
+
/**
|
|
573
|
+
* Maximum returned content length
|
|
574
|
+
*/
|
|
575
|
+
'content_limit_chars'?: number;
|
|
576
|
+
/**
|
|
577
|
+
* Include smart-click debug diagnostics
|
|
578
|
+
*/
|
|
579
|
+
'include_debug'?: boolean;
|
|
302
580
|
}
|
|
581
|
+
export declare const GuiClickXYRequestPreClickValidateEnum: {
|
|
582
|
+
readonly Off: "off";
|
|
583
|
+
readonly Warn: "warn";
|
|
584
|
+
readonly Strict: "strict";
|
|
585
|
+
};
|
|
586
|
+
export type GuiClickXYRequestPreClickValidateEnum = typeof GuiClickXYRequestPreClickValidateEnum[keyof typeof GuiClickXYRequestPreClickValidateEnum];
|
|
587
|
+
export declare const GuiClickXYRequestAutoSnapEnum: {
|
|
588
|
+
readonly Off: "off";
|
|
589
|
+
readonly NearestClickable: "nearest_clickable";
|
|
590
|
+
readonly NearestInteractive: "nearest_interactive";
|
|
591
|
+
};
|
|
592
|
+
export type GuiClickXYRequestAutoSnapEnum = typeof GuiClickXYRequestAutoSnapEnum[keyof typeof GuiClickXYRequestAutoSnapEnum];
|
|
593
|
+
export declare const GuiClickXYRequestPostClickFeedbackEnum: {
|
|
594
|
+
readonly None: "none";
|
|
595
|
+
readonly Url: "url";
|
|
596
|
+
readonly Content: "content";
|
|
597
|
+
readonly Visible: "visible";
|
|
598
|
+
readonly Auto: "auto";
|
|
599
|
+
};
|
|
600
|
+
export type GuiClickXYRequestPostClickFeedbackEnum = typeof GuiClickXYRequestPostClickFeedbackEnum[keyof typeof GuiClickXYRequestPostClickFeedbackEnum];
|
|
303
601
|
export interface GuiHoverXyRequest {
|
|
304
602
|
/**
|
|
305
603
|
* x
|
|
@@ -721,6 +1019,16 @@ export declare const WaitElementRequestUntilEnum: {
|
|
|
721
1019
|
readonly Hidden: "hidden";
|
|
722
1020
|
};
|
|
723
1021
|
export type WaitElementRequestUntilEnum = typeof WaitElementRequestUntilEnum[keyof typeof WaitElementRequestUntilEnum];
|
|
1022
|
+
export interface WhatIsVisibleRequest {
|
|
1023
|
+
/**
|
|
1024
|
+
* model
|
|
1025
|
+
*/
|
|
1026
|
+
'model'?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* stream
|
|
1029
|
+
*/
|
|
1030
|
+
'stream'?: boolean;
|
|
1031
|
+
}
|
|
724
1032
|
/**
|
|
725
1033
|
* BrowserApi - axios parameter creator
|
|
726
1034
|
*/
|
|
@@ -788,8 +1096,8 @@ export declare const BrowserApiAxiosParamCreator: (configuration?: Configuration
|
|
|
788
1096
|
*/
|
|
789
1097
|
createBrowser: (payload: CreateBrowserRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
790
1098
|
/**
|
|
791
|
-
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
|
|
792
|
-
* @summary Detect element coordinates using vision
|
|
1099
|
+
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom). model: Optional vision model override for this request. stream: Optional vision streaming override for this request. hit_test: Detect-time validation mode: off, warn, or strict. Recommended for agents: `strict`. auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive. Recommended for agents: `nearest_clickable`. snap_radius: Maximum snap radius in CSS pixels. include_debug: Include detect debug diagnostics when available.
|
|
1100
|
+
* @summary Detect element coordinates using vision with optional smart targeting
|
|
793
1101
|
* @param {string} browserId
|
|
794
1102
|
* @param {DetectCoordinatesRequest} payload
|
|
795
1103
|
* @param {*} [options] Override http request option.
|
|
@@ -878,14 +1186,23 @@ export declare const BrowserApiAxiosParamCreator: (configuration?: Configuration
|
|
|
878
1186
|
*/
|
|
879
1187
|
getUrl: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
880
1188
|
/**
|
|
881
|
-
*
|
|
882
|
-
* @summary GUI click by selector or coordinates
|
|
1189
|
+
* Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`. Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"` MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
|
|
1190
|
+
* @summary GUI click by selector or coordinates with smart validation
|
|
883
1191
|
* @param {string} browserId
|
|
884
1192
|
* @param {GuiClickRequest} payload
|
|
885
1193
|
* @param {*} [options] Override http request option.
|
|
886
1194
|
* @throws {RequiredError}
|
|
887
1195
|
*/
|
|
888
1196
|
guiClick: (browserId: string, payload: GuiClickRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1197
|
+
/**
|
|
1198
|
+
* This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
|
|
1199
|
+
* @summary MCP compatibility alias for coordinate-mode `gui_click`
|
|
1200
|
+
* @param {string} browserId
|
|
1201
|
+
* @param {GuiClickXYRequest} payload
|
|
1202
|
+
* @param {*} [options] Override http request option.
|
|
1203
|
+
* @throws {RequiredError}
|
|
1204
|
+
*/
|
|
1205
|
+
guiClickXy: (browserId: string, payload: GuiClickXYRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
889
1206
|
/**
|
|
890
1207
|
*
|
|
891
1208
|
* @summary GUI hover at coordinates
|
|
@@ -1052,10 +1369,11 @@ export declare const BrowserApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1052
1369
|
*
|
|
1053
1370
|
* @summary AI page analysis - what\'s visible
|
|
1054
1371
|
* @param {string} browserId
|
|
1372
|
+
* @param {WhatIsVisibleRequest} payload
|
|
1055
1373
|
* @param {*} [options] Override http request option.
|
|
1056
1374
|
* @throws {RequiredError}
|
|
1057
1375
|
*/
|
|
1058
|
-
whatIsVisible: (browserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1376
|
+
whatIsVisible: (browserId: string, payload: WhatIsVisibleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1059
1377
|
};
|
|
1060
1378
|
/**
|
|
1061
1379
|
* BrowserApi - functional programming interface
|
|
@@ -1124,14 +1442,14 @@ export declare const BrowserApiFp: (configuration?: Configuration) => {
|
|
|
1124
1442
|
*/
|
|
1125
1443
|
createBrowser(payload: CreateBrowserRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericResponse>>;
|
|
1126
1444
|
/**
|
|
1127
|
-
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
|
|
1128
|
-
* @summary Detect element coordinates using vision
|
|
1445
|
+
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom). model: Optional vision model override for this request. stream: Optional vision streaming override for this request. hit_test: Detect-time validation mode: off, warn, or strict. Recommended for agents: `strict`. auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive. Recommended for agents: `nearest_clickable`. snap_radius: Maximum snap radius in CSS pixels. include_debug: Include detect debug diagnostics when available.
|
|
1446
|
+
* @summary Detect element coordinates using vision with optional smart targeting
|
|
1129
1447
|
* @param {string} browserId
|
|
1130
1448
|
* @param {DetectCoordinatesRequest} payload
|
|
1131
1449
|
* @param {*} [options] Override http request option.
|
|
1132
1450
|
* @throws {RequiredError}
|
|
1133
1451
|
*/
|
|
1134
|
-
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1452
|
+
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetectCoordinatesResult>>;
|
|
1135
1453
|
/**
|
|
1136
1454
|
*
|
|
1137
1455
|
* @summary Dialogs: get, accept, dismiss
|
|
@@ -1214,14 +1532,23 @@ export declare const BrowserApiFp: (configuration?: Configuration) => {
|
|
|
1214
1532
|
*/
|
|
1215
1533
|
getUrl(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericResponse>>;
|
|
1216
1534
|
/**
|
|
1217
|
-
*
|
|
1218
|
-
* @summary GUI click by selector or coordinates
|
|
1535
|
+
* Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`. Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"` MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
|
|
1536
|
+
* @summary GUI click by selector or coordinates with smart validation
|
|
1219
1537
|
* @param {string} browserId
|
|
1220
1538
|
* @param {GuiClickRequest} payload
|
|
1221
1539
|
* @param {*} [options] Override http request option.
|
|
1222
1540
|
* @throws {RequiredError}
|
|
1223
1541
|
*/
|
|
1224
|
-
guiClick(browserId: string, payload: GuiClickRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1542
|
+
guiClick(browserId: string, payload: GuiClickRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuiClickResult>>;
|
|
1543
|
+
/**
|
|
1544
|
+
* This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
|
|
1545
|
+
* @summary MCP compatibility alias for coordinate-mode `gui_click`
|
|
1546
|
+
* @param {string} browserId
|
|
1547
|
+
* @param {GuiClickXYRequest} payload
|
|
1548
|
+
* @param {*} [options] Override http request option.
|
|
1549
|
+
* @throws {RequiredError}
|
|
1550
|
+
*/
|
|
1551
|
+
guiClickXy(browserId: string, payload: GuiClickXYRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuiClickResult>>;
|
|
1225
1552
|
/**
|
|
1226
1553
|
*
|
|
1227
1554
|
* @summary GUI hover at coordinates
|
|
@@ -1388,10 +1715,11 @@ export declare const BrowserApiFp: (configuration?: Configuration) => {
|
|
|
1388
1715
|
*
|
|
1389
1716
|
* @summary AI page analysis - what\'s visible
|
|
1390
1717
|
* @param {string} browserId
|
|
1718
|
+
* @param {WhatIsVisibleRequest} payload
|
|
1391
1719
|
* @param {*} [options] Override http request option.
|
|
1392
1720
|
* @throws {RequiredError}
|
|
1393
1721
|
*/
|
|
1394
|
-
whatIsVisible(browserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericResponse>>;
|
|
1722
|
+
whatIsVisible(browserId: string, payload: WhatIsVisibleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericResponse>>;
|
|
1395
1723
|
};
|
|
1396
1724
|
/**
|
|
1397
1725
|
* BrowserApi - factory interface
|
|
@@ -1460,14 +1788,14 @@ export declare const BrowserApiFactory: (configuration?: Configuration, basePath
|
|
|
1460
1788
|
*/
|
|
1461
1789
|
createBrowser(payload: CreateBrowserRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenericResponse>;
|
|
1462
1790
|
/**
|
|
1463
|
-
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
|
|
1464
|
-
* @summary Detect element coordinates using vision
|
|
1791
|
+
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom). model: Optional vision model override for this request. stream: Optional vision streaming override for this request. hit_test: Detect-time validation mode: off, warn, or strict. Recommended for agents: `strict`. auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive. Recommended for agents: `nearest_clickable`. snap_radius: Maximum snap radius in CSS pixels. include_debug: Include detect debug diagnostics when available.
|
|
1792
|
+
* @summary Detect element coordinates using vision with optional smart targeting
|
|
1465
1793
|
* @param {string} browserId
|
|
1466
1794
|
* @param {DetectCoordinatesRequest} payload
|
|
1467
1795
|
* @param {*} [options] Override http request option.
|
|
1468
1796
|
* @throws {RequiredError}
|
|
1469
1797
|
*/
|
|
1470
|
-
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1798
|
+
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<DetectCoordinatesResult>;
|
|
1471
1799
|
/**
|
|
1472
1800
|
*
|
|
1473
1801
|
* @summary Dialogs: get, accept, dismiss
|
|
@@ -1550,14 +1878,23 @@ export declare const BrowserApiFactory: (configuration?: Configuration, basePath
|
|
|
1550
1878
|
*/
|
|
1551
1879
|
getUrl(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<GenericResponse>;
|
|
1552
1880
|
/**
|
|
1553
|
-
*
|
|
1554
|
-
* @summary GUI click by selector or coordinates
|
|
1881
|
+
* Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`. Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"` MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
|
|
1882
|
+
* @summary GUI click by selector or coordinates with smart validation
|
|
1555
1883
|
* @param {string} browserId
|
|
1556
1884
|
* @param {GuiClickRequest} payload
|
|
1557
1885
|
* @param {*} [options] Override http request option.
|
|
1558
1886
|
* @throws {RequiredError}
|
|
1559
1887
|
*/
|
|
1560
|
-
guiClick(browserId: string, payload: GuiClickRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1888
|
+
guiClick(browserId: string, payload: GuiClickRequest, options?: RawAxiosRequestConfig): AxiosPromise<GuiClickResult>;
|
|
1889
|
+
/**
|
|
1890
|
+
* This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
|
|
1891
|
+
* @summary MCP compatibility alias for coordinate-mode `gui_click`
|
|
1892
|
+
* @param {string} browserId
|
|
1893
|
+
* @param {GuiClickXYRequest} payload
|
|
1894
|
+
* @param {*} [options] Override http request option.
|
|
1895
|
+
* @throws {RequiredError}
|
|
1896
|
+
*/
|
|
1897
|
+
guiClickXy(browserId: string, payload: GuiClickXYRequest, options?: RawAxiosRequestConfig): AxiosPromise<GuiClickResult>;
|
|
1561
1898
|
/**
|
|
1562
1899
|
*
|
|
1563
1900
|
* @summary GUI hover at coordinates
|
|
@@ -1724,10 +2061,11 @@ export declare const BrowserApiFactory: (configuration?: Configuration, basePath
|
|
|
1724
2061
|
*
|
|
1725
2062
|
* @summary AI page analysis - what\'s visible
|
|
1726
2063
|
* @param {string} browserId
|
|
2064
|
+
* @param {WhatIsVisibleRequest} payload
|
|
1727
2065
|
* @param {*} [options] Override http request option.
|
|
1728
2066
|
* @throws {RequiredError}
|
|
1729
2067
|
*/
|
|
1730
|
-
whatIsVisible(browserId: string, options?: RawAxiosRequestConfig): AxiosPromise<GenericResponse>;
|
|
2068
|
+
whatIsVisible(browserId: string, payload: WhatIsVisibleRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenericResponse>;
|
|
1731
2069
|
};
|
|
1732
2070
|
/**
|
|
1733
2071
|
* BrowserApi - object-oriented interface
|
|
@@ -1796,14 +2134,14 @@ export declare class BrowserApi extends BaseAPI {
|
|
|
1796
2134
|
*/
|
|
1797
2135
|
createBrowser(payload: CreateBrowserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenericResponse, any, {}>>;
|
|
1798
2136
|
/**
|
|
1799
|
-
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom).
|
|
1800
|
-
* @summary Detect element coordinates using vision
|
|
2137
|
+
* Args: browser_id: Browser instance identifier prompt: Natural language description of element to find fx: Fractional x offset for click point (0.0=left, 0.5=center, 1.0=right). If None, auto-bias is applied for wide elements (0.25 for aspect ratio > 10). fy: Fractional y offset for click point (0.0=top, 0.5=center, 1.0=bottom). model: Optional vision model override for this request. stream: Optional vision streaming override for this request. hit_test: Detect-time validation mode: off, warn, or strict. Recommended for agents: `strict`. auto_snap: Auto-snap mode: off, nearest_clickable, or nearest_interactive. Recommended for agents: `nearest_clickable`. snap_radius: Maximum snap radius in CSS pixels. include_debug: Include detect debug diagnostics when available.
|
|
2138
|
+
* @summary Detect element coordinates using vision with optional smart targeting
|
|
1801
2139
|
* @param {string} browserId
|
|
1802
2140
|
* @param {DetectCoordinatesRequest} payload
|
|
1803
2141
|
* @param {*} [options] Override http request option.
|
|
1804
2142
|
* @throws {RequiredError}
|
|
1805
2143
|
*/
|
|
1806
|
-
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2144
|
+
detectCoordinates(browserId: string, payload: DetectCoordinatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetectCoordinatesResult, any, {}>>;
|
|
1807
2145
|
/**
|
|
1808
2146
|
*
|
|
1809
2147
|
* @summary Dialogs: get, accept, dismiss
|
|
@@ -1886,14 +2224,23 @@ export declare class BrowserApi extends BaseAPI {
|
|
|
1886
2224
|
*/
|
|
1887
2225
|
getUrl(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenericResponse, any, {}>>;
|
|
1888
2226
|
/**
|
|
1889
|
-
*
|
|
1890
|
-
* @summary GUI click by selector or coordinates
|
|
2227
|
+
* Selector mode uses `selector` with optional `fx` / `fy` offsets. Coordinate mode uses `x` / `y` and supports smart targeting knobs such as `pre_click_validate`, `auto_snap`, and `post_click_feedback`. Recommended agent mode: - `pre_click_validate=\"strict\"` - `auto_snap=\"nearest_clickable\"` - `post_click_feedback=\"auto\"` MCP keeps `gui_click_xy` as a compatibility alias for coordinate-mode `gui_click`.
|
|
2228
|
+
* @summary GUI click by selector or coordinates with smart validation
|
|
1891
2229
|
* @param {string} browserId
|
|
1892
2230
|
* @param {GuiClickRequest} payload
|
|
1893
2231
|
* @param {*} [options] Override http request option.
|
|
1894
2232
|
* @throws {RequiredError}
|
|
1895
2233
|
*/
|
|
1896
|
-
guiClick(browserId: string, payload: GuiClickRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2234
|
+
guiClick(browserId: string, payload: GuiClickRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GuiClickResult, any, {}>>;
|
|
2235
|
+
/**
|
|
2236
|
+
* This mirrors coordinate-mode `gui_click`, accepts the same smart-click options, and returns the same response contract.
|
|
2237
|
+
* @summary MCP compatibility alias for coordinate-mode `gui_click`
|
|
2238
|
+
* @param {string} browserId
|
|
2239
|
+
* @param {GuiClickXYRequest} payload
|
|
2240
|
+
* @param {*} [options] Override http request option.
|
|
2241
|
+
* @throws {RequiredError}
|
|
2242
|
+
*/
|
|
2243
|
+
guiClickXy(browserId: string, payload: GuiClickXYRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GuiClickResult, any, {}>>;
|
|
1897
2244
|
/**
|
|
1898
2245
|
*
|
|
1899
2246
|
* @summary GUI hover at coordinates
|
|
@@ -2060,10 +2407,11 @@ export declare class BrowserApi extends BaseAPI {
|
|
|
2060
2407
|
*
|
|
2061
2408
|
* @summary AI page analysis - what\'s visible
|
|
2062
2409
|
* @param {string} browserId
|
|
2410
|
+
* @param {WhatIsVisibleRequest} payload
|
|
2063
2411
|
* @param {*} [options] Override http request option.
|
|
2064
2412
|
* @throws {RequiredError}
|
|
2065
2413
|
*/
|
|
2066
|
-
whatIsVisible(browserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenericResponse, any, {}>>;
|
|
2414
|
+
whatIsVisible(browserId: string, payload: WhatIsVisibleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenericResponse, any, {}>>;
|
|
2067
2415
|
}
|
|
2068
2416
|
/**
|
|
2069
2417
|
* HealthApi - axios parameter creator
|