@onkernel/sdk 0.43.0 → 0.45.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.
Files changed (57) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/package.json +1 -1
  3. package/resources/auth/auth.d.mts +2 -2
  4. package/resources/auth/auth.d.mts.map +1 -1
  5. package/resources/auth/auth.d.ts +2 -2
  6. package/resources/auth/auth.d.ts.map +1 -1
  7. package/resources/auth/auth.js.map +1 -1
  8. package/resources/auth/auth.mjs.map +1 -1
  9. package/resources/auth/connections.d.mts +233 -7
  10. package/resources/auth/connections.d.mts.map +1 -1
  11. package/resources/auth/connections.d.ts +233 -7
  12. package/resources/auth/connections.d.ts.map +1 -1
  13. package/resources/auth/connections.js +14 -0
  14. package/resources/auth/connections.js.map +1 -1
  15. package/resources/auth/connections.mjs +14 -0
  16. package/resources/auth/connections.mjs.map +1 -1
  17. package/resources/auth/index.d.mts +1 -1
  18. package/resources/auth/index.d.mts.map +1 -1
  19. package/resources/auth/index.d.ts +1 -1
  20. package/resources/auth/index.d.ts.map +1 -1
  21. package/resources/auth/index.js.map +1 -1
  22. package/resources/auth/index.mjs.map +1 -1
  23. package/resources/browser-pools.d.mts +57 -13
  24. package/resources/browser-pools.d.mts.map +1 -1
  25. package/resources/browser-pools.d.ts +57 -13
  26. package/resources/browser-pools.d.ts.map +1 -1
  27. package/resources/browsers/browsers.d.mts +50 -21
  28. package/resources/browsers/browsers.d.mts.map +1 -1
  29. package/resources/browsers/browsers.d.ts +50 -21
  30. package/resources/browsers/browsers.d.ts.map +1 -1
  31. package/resources/browsers/browsers.js.map +1 -1
  32. package/resources/browsers/browsers.mjs.map +1 -1
  33. package/resources/browsers/computer.d.mts +28 -4
  34. package/resources/browsers/computer.d.mts.map +1 -1
  35. package/resources/browsers/computer.d.ts +28 -4
  36. package/resources/browsers/computer.d.ts.map +1 -1
  37. package/resources/invocations.d.mts +9 -4
  38. package/resources/invocations.d.mts.map +1 -1
  39. package/resources/invocations.d.ts +9 -4
  40. package/resources/invocations.d.ts.map +1 -1
  41. package/resources/shared.d.mts +7 -3
  42. package/resources/shared.d.mts.map +1 -1
  43. package/resources/shared.d.ts +7 -3
  44. package/resources/shared.d.ts.map +1 -1
  45. package/src/resources/auth/auth.ts +4 -0
  46. package/src/resources/auth/connections.ts +273 -6
  47. package/src/resources/auth/index.ts +2 -0
  48. package/src/resources/browser-pools.ts +54 -13
  49. package/src/resources/browsers/browsers.ts +51 -21
  50. package/src/resources/browsers/computer.ts +32 -4
  51. package/src/resources/invocations.ts +9 -4
  52. package/src/resources/shared.ts +7 -3
  53. package/src/version.ts +1 -1
  54. package/version.d.mts +1 -1
  55. package/version.d.ts +1 -1
  56. package/version.js +1 -1
  57. package/version.mjs +1 -1
@@ -44,6 +44,21 @@ export class Connections extends APIResource {
44
44
  return this._client.get(path`/auth/connections/${id}`, options);
45
45
  }
46
46
 
47
+ /**
48
+ * Update an auth connection's configuration. Only the fields provided will be
49
+ * updated.
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * const managedAuth = await client.auth.connections.update(
54
+ * 'id',
55
+ * );
56
+ * ```
57
+ */
58
+ update(id: string, body: ConnectionUpdateParams, options?: RequestOptions): APIPromise<ManagedAuth> {
59
+ return this._client.patch(path`/auth/connections/${id}`, { body, ...options });
60
+ }
61
+
47
62
  /**
48
63
  * List auth connections with optional filters for profile_name and domain.
49
64
  *
@@ -340,6 +355,12 @@ export interface ManagedAuth {
340
355
  */
341
356
  proxy_id?: string;
342
357
 
358
+ /**
359
+ * Non-MFA choices presented during the auth flow, such as account selection or org
360
+ * pickers (present when flow_step=awaiting_input).
361
+ */
362
+ sign_in_options?: Array<ManagedAuth.SignInOption> | null;
363
+
343
364
  /**
344
365
  * SSO provider being used (e.g., google, github, microsoft)
345
366
  */
@@ -467,6 +488,27 @@ export namespace ManagedAuth {
467
488
  */
468
489
  selector: string;
469
490
  }
491
+
492
+ /**
493
+ * A non-MFA choice presented during the auth flow (e.g. account selection, org
494
+ * picker)
495
+ */
496
+ export interface SignInOption {
497
+ /**
498
+ * Unique identifier for this option (used to submit selection back)
499
+ */
500
+ id: string;
501
+
502
+ /**
503
+ * Display text for the option
504
+ */
505
+ label: string;
506
+
507
+ /**
508
+ * Additional context such as email address or org name
509
+ */
510
+ description?: string | null;
511
+ }
470
512
  }
471
513
 
472
514
  /**
@@ -588,8 +630,96 @@ export namespace ManagedAuthCreateRequest {
588
630
  }
589
631
 
590
632
  /**
591
- * Request to submit field values, click an SSO button, or select an MFA method.
592
- * Provide exactly one of fields, sso_button_selector, or mfa_option_id.
633
+ * Request to update an auth connection's configuration
634
+ */
635
+ export interface ManagedAuthUpdateRequest {
636
+ /**
637
+ * Additional domains valid for this auth flow (replaces existing list)
638
+ */
639
+ allowed_domains?: Array<string>;
640
+
641
+ /**
642
+ * Reference to credentials for the auth connection. Use one of:
643
+ *
644
+ * - { name } for Kernel credentials
645
+ * - { provider, path } for external provider item
646
+ * - { provider, auto: true } for external provider domain lookup
647
+ */
648
+ credential?: ManagedAuthUpdateRequest.Credential;
649
+
650
+ /**
651
+ * Interval in seconds between automatic health checks
652
+ */
653
+ health_check_interval?: number;
654
+
655
+ /**
656
+ * Login page URL. Set to empty string to clear.
657
+ */
658
+ login_url?: string;
659
+
660
+ /**
661
+ * Proxy selection. Provide either id or name. The proxy must belong to the
662
+ * caller's org.
663
+ */
664
+ proxy?: ManagedAuthUpdateRequest.Proxy;
665
+
666
+ /**
667
+ * Whether to save credentials after every successful login
668
+ */
669
+ save_credentials?: boolean;
670
+ }
671
+
672
+ export namespace ManagedAuthUpdateRequest {
673
+ /**
674
+ * Reference to credentials for the auth connection. Use one of:
675
+ *
676
+ * - { name } for Kernel credentials
677
+ * - { provider, path } for external provider item
678
+ * - { provider, auto: true } for external provider domain lookup
679
+ */
680
+ export interface Credential {
681
+ /**
682
+ * If true, lookup by domain from the specified provider
683
+ */
684
+ auto?: boolean;
685
+
686
+ /**
687
+ * Kernel credential name
688
+ */
689
+ name?: string;
690
+
691
+ /**
692
+ * Provider-specific path (e.g., "VaultName/ItemName" for 1Password)
693
+ */
694
+ path?: string;
695
+
696
+ /**
697
+ * External provider name (e.g., "my-1p")
698
+ */
699
+ provider?: string;
700
+ }
701
+
702
+ /**
703
+ * Proxy selection. Provide either id or name. The proxy must belong to the
704
+ * caller's org.
705
+ */
706
+ export interface Proxy {
707
+ /**
708
+ * Proxy ID
709
+ */
710
+ id?: string;
711
+
712
+ /**
713
+ * Proxy name
714
+ */
715
+ name?: string;
716
+ }
717
+ }
718
+
719
+ /**
720
+ * Request to submit field values, click an SSO button, select an MFA method, or
721
+ * select a sign-in option. Provide exactly one of fields, sso_button_selector,
722
+ * sso_provider, mfa_option_id, or sign_in_option_id.
593
723
  */
594
724
  export interface SubmitFieldsRequest {
595
725
  /**
@@ -598,14 +728,26 @@ export interface SubmitFieldsRequest {
598
728
  fields?: { [key: string]: string };
599
729
 
600
730
  /**
601
- * Optional MFA option ID if user selected an MFA method
731
+ * The MFA method type to select (when mfa_options were returned)
602
732
  */
603
733
  mfa_option_id?: string;
604
734
 
605
735
  /**
606
- * Optional XPath selector if user chose to click an SSO button instead
736
+ * The sign-in option ID to select (when sign_in_options were returned)
737
+ */
738
+ sign_in_option_id?: string;
739
+
740
+ /**
741
+ * XPath selector for the SSO button to click (ODA). Use sso_provider instead for
742
+ * CUA.
607
743
  */
608
744
  sso_button_selector?: string;
745
+
746
+ /**
747
+ * SSO provider to click, matching the provider field from pending_sso_buttons
748
+ * (e.g., "google", "github"). Cannot be used with sso_button_selector.
749
+ */
750
+ sso_provider?: string;
609
751
  }
610
752
 
611
753
  /**
@@ -703,6 +845,12 @@ export namespace ConnectionFollowResponse {
703
845
  */
704
846
  post_login_url?: string;
705
847
 
848
+ /**
849
+ * Non-MFA choices presented during the auth flow, such as account selection or org
850
+ * pickers (present when flow_step=AWAITING_INPUT).
851
+ */
852
+ sign_in_options?: Array<ManagedAuthStateEvent.SignInOption>;
853
+
706
854
  /**
707
855
  * Visible error message from the website (e.g., 'Incorrect password'). Present
708
856
  * when the website displays an error during login.
@@ -796,6 +944,27 @@ export namespace ConnectionFollowResponse {
796
944
  */
797
945
  selector: string;
798
946
  }
947
+
948
+ /**
949
+ * A non-MFA choice presented during the auth flow (e.g. account selection, org
950
+ * picker)
951
+ */
952
+ export interface SignInOption {
953
+ /**
954
+ * Unique identifier for this option (used to submit selection back)
955
+ */
956
+ id: string;
957
+
958
+ /**
959
+ * Display text for the option
960
+ */
961
+ label: string;
962
+
963
+ /**
964
+ * Additional context such as email address or org name
965
+ */
966
+ description?: string | null;
967
+ }
799
968
  }
800
969
  }
801
970
 
@@ -914,6 +1083,90 @@ export namespace ConnectionCreateParams {
914
1083
  }
915
1084
  }
916
1085
 
1086
+ export interface ConnectionUpdateParams {
1087
+ /**
1088
+ * Additional domains valid for this auth flow (replaces existing list)
1089
+ */
1090
+ allowed_domains?: Array<string>;
1091
+
1092
+ /**
1093
+ * Reference to credentials for the auth connection. Use one of:
1094
+ *
1095
+ * - { name } for Kernel credentials
1096
+ * - { provider, path } for external provider item
1097
+ * - { provider, auto: true } for external provider domain lookup
1098
+ */
1099
+ credential?: ConnectionUpdateParams.Credential;
1100
+
1101
+ /**
1102
+ * Interval in seconds between automatic health checks
1103
+ */
1104
+ health_check_interval?: number;
1105
+
1106
+ /**
1107
+ * Login page URL. Set to empty string to clear.
1108
+ */
1109
+ login_url?: string;
1110
+
1111
+ /**
1112
+ * Proxy selection. Provide either id or name. The proxy must belong to the
1113
+ * caller's org.
1114
+ */
1115
+ proxy?: ConnectionUpdateParams.Proxy;
1116
+
1117
+ /**
1118
+ * Whether to save credentials after every successful login
1119
+ */
1120
+ save_credentials?: boolean;
1121
+ }
1122
+
1123
+ export namespace ConnectionUpdateParams {
1124
+ /**
1125
+ * Reference to credentials for the auth connection. Use one of:
1126
+ *
1127
+ * - { name } for Kernel credentials
1128
+ * - { provider, path } for external provider item
1129
+ * - { provider, auto: true } for external provider domain lookup
1130
+ */
1131
+ export interface Credential {
1132
+ /**
1133
+ * If true, lookup by domain from the specified provider
1134
+ */
1135
+ auto?: boolean;
1136
+
1137
+ /**
1138
+ * Kernel credential name
1139
+ */
1140
+ name?: string;
1141
+
1142
+ /**
1143
+ * Provider-specific path (e.g., "VaultName/ItemName" for 1Password)
1144
+ */
1145
+ path?: string;
1146
+
1147
+ /**
1148
+ * External provider name (e.g., "my-1p")
1149
+ */
1150
+ provider?: string;
1151
+ }
1152
+
1153
+ /**
1154
+ * Proxy selection. Provide either id or name. The proxy must belong to the
1155
+ * caller's org.
1156
+ */
1157
+ export interface Proxy {
1158
+ /**
1159
+ * Proxy ID
1160
+ */
1161
+ id?: string;
1162
+
1163
+ /**
1164
+ * Proxy name
1165
+ */
1166
+ name?: string;
1167
+ }
1168
+ }
1169
+
917
1170
  export interface ConnectionListParams extends OffsetPaginationParams {
918
1171
  /**
919
1172
  * Filter by domain
@@ -959,14 +1212,26 @@ export interface ConnectionSubmitParams {
959
1212
  fields?: { [key: string]: string };
960
1213
 
961
1214
  /**
962
- * Optional MFA option ID if user selected an MFA method
1215
+ * The MFA method type to select (when mfa_options were returned)
963
1216
  */
964
1217
  mfa_option_id?: string;
965
1218
 
966
1219
  /**
967
- * Optional XPath selector if user chose to click an SSO button instead
1220
+ * The sign-in option ID to select (when sign_in_options were returned)
1221
+ */
1222
+ sign_in_option_id?: string;
1223
+
1224
+ /**
1225
+ * XPath selector for the SSO button to click (ODA). Use sso_provider instead for
1226
+ * CUA.
968
1227
  */
969
1228
  sso_button_selector?: string;
1229
+
1230
+ /**
1231
+ * SSO provider to click, matching the provider field from pending_sso_buttons
1232
+ * (e.g., "google", "github"). Cannot be used with sso_button_selector.
1233
+ */
1234
+ sso_provider?: string;
970
1235
  }
971
1236
 
972
1237
  export declare namespace Connections {
@@ -974,11 +1239,13 @@ export declare namespace Connections {
974
1239
  type LoginResponse as LoginResponse,
975
1240
  type ManagedAuth as ManagedAuth,
976
1241
  type ManagedAuthCreateRequest as ManagedAuthCreateRequest,
1242
+ type ManagedAuthUpdateRequest as ManagedAuthUpdateRequest,
977
1243
  type SubmitFieldsRequest as SubmitFieldsRequest,
978
1244
  type SubmitFieldsResponse as SubmitFieldsResponse,
979
1245
  type ConnectionFollowResponse as ConnectionFollowResponse,
980
1246
  type ManagedAuthsOffsetPagination as ManagedAuthsOffsetPagination,
981
1247
  type ConnectionCreateParams as ConnectionCreateParams,
1248
+ type ConnectionUpdateParams as ConnectionUpdateParams,
982
1249
  type ConnectionListParams as ConnectionListParams,
983
1250
  type ConnectionLoginParams as ConnectionLoginParams,
984
1251
  type ConnectionSubmitParams as ConnectionSubmitParams,
@@ -6,10 +6,12 @@ export {
6
6
  type LoginResponse,
7
7
  type ManagedAuth,
8
8
  type ManagedAuthCreateRequest,
9
+ type ManagedAuthUpdateRequest,
9
10
  type SubmitFieldsRequest,
10
11
  type SubmitFieldsResponse,
11
12
  type ConnectionFollowResponse,
12
13
  type ConnectionCreateParams,
14
+ type ConnectionUpdateParams,
13
15
  type ConnectionListParams,
14
16
  type ConnectionLoginParams,
15
17
  type ConnectionSubmitParams,
@@ -190,6 +190,14 @@ export namespace BrowserPool {
190
190
  */
191
191
  size: number;
192
192
 
193
+ /**
194
+ * Custom Chrome enterprise policy overrides applied to all browsers in this pool.
195
+ * Keys are Chrome enterprise policy names; values must match their expected types.
196
+ * Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See
197
+ * https://chromeenterprise.google/policies/
198
+ */
199
+ chrome_policy?: { [key: string]: unknown };
200
+
193
201
  /**
194
202
  * List of browser extensions to load into the session. Provide each by id or name.
195
203
  */
@@ -243,9 +251,13 @@ export namespace BrowserPool {
243
251
 
244
252
  /**
245
253
  * Initial browser window size in pixels with optional refresh rate. If omitted,
246
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
247
- * but the following configurations are known-good and fully tested: 2560x1440@10,
248
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
254
+ * image defaults apply (1920x1080@25). For GPU images, the default is
255
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
256
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
257
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
258
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
259
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
260
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
249
261
  * Viewports outside this list may exhibit unstable live view or recording
250
262
  * behavior. If refresh_rate is not provided, it will be automatically determined
251
263
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -305,7 +317,8 @@ export interface BrowserPoolAcquireResponse {
305
317
  deleted_at?: string;
306
318
 
307
319
  /**
308
- * Whether the browser session has hardware-accelerated GPU rendering.
320
+ * Whether GPU acceleration is enabled for the browser session (only supported for
321
+ * headful sessions).
309
322
  */
310
323
  gpu?: boolean;
311
324
 
@@ -342,9 +355,13 @@ export interface BrowserPoolAcquireResponse {
342
355
 
343
356
  /**
344
357
  * Initial browser window size in pixels with optional refresh rate. If omitted,
345
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
346
- * but the following configurations are known-good and fully tested: 2560x1440@10,
347
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
358
+ * image defaults apply (1920x1080@25). For GPU images, the default is
359
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
360
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
361
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
362
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
363
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
364
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
348
365
  * Viewports outside this list may exhibit unstable live view or recording
349
366
  * behavior. If refresh_rate is not provided, it will be automatically determined
350
367
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -361,6 +378,14 @@ export interface BrowserPoolCreateParams {
361
378
  */
362
379
  size: number;
363
380
 
381
+ /**
382
+ * Custom Chrome enterprise policy overrides applied to all browsers in this pool.
383
+ * Keys are Chrome enterprise policy names; values must match their expected types.
384
+ * Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See
385
+ * https://chromeenterprise.google/policies/
386
+ */
387
+ chrome_policy?: { [key: string]: unknown };
388
+
364
389
  /**
365
390
  * List of browser extensions to load into the session. Provide each by id or name.
366
391
  */
@@ -414,9 +439,13 @@ export interface BrowserPoolCreateParams {
414
439
 
415
440
  /**
416
441
  * Initial browser window size in pixels with optional refresh rate. If omitted,
417
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
418
- * but the following configurations are known-good and fully tested: 2560x1440@10,
419
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
442
+ * image defaults apply (1920x1080@25). For GPU images, the default is
443
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
444
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
445
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
446
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
447
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
448
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
420
449
  * Viewports outside this list may exhibit unstable live view or recording
421
450
  * behavior. If refresh_rate is not provided, it will be automatically determined
422
451
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -433,6 +462,14 @@ export interface BrowserPoolUpdateParams {
433
462
  */
434
463
  size: number;
435
464
 
465
+ /**
466
+ * Custom Chrome enterprise policy overrides applied to all browsers in this pool.
467
+ * Keys are Chrome enterprise policy names; values must match their expected types.
468
+ * Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See
469
+ * https://chromeenterprise.google/policies/
470
+ */
471
+ chrome_policy?: { [key: string]: unknown };
472
+
436
473
  /**
437
474
  * Whether to discard all idle browsers and rebuild the pool immediately. Defaults
438
475
  * to false.
@@ -492,9 +529,13 @@ export interface BrowserPoolUpdateParams {
492
529
 
493
530
  /**
494
531
  * Initial browser window size in pixels with optional refresh rate. If omitted,
495
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
496
- * but the following configurations are known-good and fully tested: 2560x1440@10,
497
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
532
+ * image defaults apply (1920x1080@25). For GPU images, the default is
533
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
534
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
535
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
536
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
537
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
538
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
498
539
  * Viewports outside this list may exhibit unstable live view or recording
499
540
  * behavior. If refresh_rate is not provided, it will be automatically determined
500
541
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -330,7 +330,8 @@ export interface BrowserCreateResponse {
330
330
  deleted_at?: string;
331
331
 
332
332
  /**
333
- * Whether the browser session has hardware-accelerated GPU rendering.
333
+ * Whether GPU acceleration is enabled for the browser session (only supported for
334
+ * headful sessions).
334
335
  */
335
336
  gpu?: boolean;
336
337
 
@@ -367,9 +368,13 @@ export interface BrowserCreateResponse {
367
368
 
368
369
  /**
369
370
  * Initial browser window size in pixels with optional refresh rate. If omitted,
370
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
371
- * but the following configurations are known-good and fully tested: 2560x1440@10,
372
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
371
+ * image defaults apply (1920x1080@25). For GPU images, the default is
372
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
373
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
374
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
375
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
376
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
377
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
373
378
  * Viewports outside this list may exhibit unstable live view or recording
374
379
  * behavior. If refresh_rate is not provided, it will be automatically determined
375
380
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -426,7 +431,8 @@ export interface BrowserRetrieveResponse {
426
431
  deleted_at?: string;
427
432
 
428
433
  /**
429
- * Whether the browser session has hardware-accelerated GPU rendering.
434
+ * Whether GPU acceleration is enabled for the browser session (only supported for
435
+ * headful sessions).
430
436
  */
431
437
  gpu?: boolean;
432
438
 
@@ -463,9 +469,13 @@ export interface BrowserRetrieveResponse {
463
469
 
464
470
  /**
465
471
  * Initial browser window size in pixels with optional refresh rate. If omitted,
466
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
467
- * but the following configurations are known-good and fully tested: 2560x1440@10,
468
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
472
+ * image defaults apply (1920x1080@25). For GPU images, the default is
473
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
474
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
475
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
476
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
477
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
478
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
469
479
  * Viewports outside this list may exhibit unstable live view or recording
470
480
  * behavior. If refresh_rate is not provided, it will be automatically determined
471
481
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -522,7 +532,8 @@ export interface BrowserUpdateResponse {
522
532
  deleted_at?: string;
523
533
 
524
534
  /**
525
- * Whether the browser session has hardware-accelerated GPU rendering.
535
+ * Whether GPU acceleration is enabled for the browser session (only supported for
536
+ * headful sessions).
526
537
  */
527
538
  gpu?: boolean;
528
539
 
@@ -559,9 +570,13 @@ export interface BrowserUpdateResponse {
559
570
 
560
571
  /**
561
572
  * Initial browser window size in pixels with optional refresh rate. If omitted,
562
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
563
- * but the following configurations are known-good and fully tested: 2560x1440@10,
564
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
573
+ * image defaults apply (1920x1080@25). For GPU images, the default is
574
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
575
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
576
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
577
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
578
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
579
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
565
580
  * Viewports outside this list may exhibit unstable live view or recording
566
581
  * behavior. If refresh_rate is not provided, it will be automatically determined
567
582
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -618,7 +633,8 @@ export interface BrowserListResponse {
618
633
  deleted_at?: string;
619
634
 
620
635
  /**
621
- * Whether the browser session has hardware-accelerated GPU rendering.
636
+ * Whether GPU acceleration is enabled for the browser session (only supported for
637
+ * headful sessions).
622
638
  */
623
639
  gpu?: boolean;
624
640
 
@@ -655,9 +671,13 @@ export interface BrowserListResponse {
655
671
 
656
672
  /**
657
673
  * Initial browser window size in pixels with optional refresh rate. If omitted,
658
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
659
- * but the following configurations are known-good and fully tested: 2560x1440@10,
660
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
674
+ * image defaults apply (1920x1080@25). For GPU images, the default is
675
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
676
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
677
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
678
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
679
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
680
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
661
681
  * Viewports outside this list may exhibit unstable live view or recording
662
682
  * behavior. If refresh_rate is not provided, it will be automatically determined
663
683
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -673,8 +693,8 @@ export interface BrowserCreateParams {
673
693
  extensions?: Array<Shared.BrowserExtension>;
674
694
 
675
695
  /**
676
- * If true, launches a hardware-accelerated browser with GPU rendering. Requires
677
- * Start-Up or Enterprise plan.
696
+ * If true, enables GPU acceleration for the browser session. Requires Start-Up or
697
+ * Enterprise plan and headless=false.
678
698
  */
679
699
  gpu?: boolean;
680
700
 
@@ -731,9 +751,13 @@ export interface BrowserCreateParams {
731
751
 
732
752
  /**
733
753
  * Initial browser window size in pixels with optional refresh rate. If omitted,
734
- * image defaults apply (1920x1080@25). Arbitrary viewport dimensions are accepted,
735
- * but the following configurations are known-good and fully tested: 2560x1440@10,
736
- * 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60.
754
+ * image defaults apply (1920x1080@25). For GPU images, the default is
755
+ * 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted.
756
+ * Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25,
757
+ * 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60. For GPU images, recommended
758
+ * presets use one of these resolutions with refresh rates 60, 30, 25, or 10:
759
+ * 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768,
760
+ * 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600.
737
761
  * Viewports outside this list may exhibit unstable live view or recording
738
762
  * behavior. If refresh_rate is not provided, it will be automatically determined
739
763
  * based on the resolution (higher resolutions use lower refresh rates to keep
@@ -750,6 +774,12 @@ export interface BrowserRetrieveParams {
750
774
  }
751
775
 
752
776
  export interface BrowserUpdateParams {
777
+ /**
778
+ * If true, stealth browsers connect directly instead of using the default stealth
779
+ * proxy.
780
+ */
781
+ disable_default_proxy?: boolean;
782
+
753
783
  /**
754
784
  * Profile to load into the browser session. Only allowed if the session does not
755
785
  * already have a profile loaded.