feat(api): headless browsers

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 17
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-0ac9428eb663361184124cdd6a6e80ae8dc72c927626c949f22aacc4f40095de.yml
-openapi_spec_hash: 27707667d706ac33f2d9ccb23c0f15c3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-3ec96d0022acb32aa2676c2e7ae20152b899a776ccd499380c334c955b9ba071.yml
+openapi_spec_hash: b64c095d82185c1cd0355abea88b606f
 config_hash: 00ec9df250b9dc077f8d3b93a442d252

src/resources/browsers.ts

@@ -97,11 +97,6 @@ export interface BrowserPersistence {
 }
 
 export interface BrowserCreateResponse {
-  /**
-   * Remote URL for live viewing the browser session
-   */
-  browser_live_view_url: string;
-
   /**
    * Websocket URL for Chrome DevTools Protocol connections to the browser session
    */
@@ -112,18 +107,19 @@ export interface BrowserCreateResponse {
    */
   session_id: string;
 
+  /**
+   * Remote URL for live viewing the browser session. Only available for non-headless
+   * browsers.
+   */
+  browser_live_view_url?: string;
+
   /**
    * Optional persistence configuration for the browser session.
    */
   persistence?: BrowserPersistence;
 }
 
 export interface BrowserRetrieveResponse {
-  /**
-   * Remote URL for live viewing the browser session
-   */
-  browser_live_view_url: string;
-
   /**
    * Websocket URL for Chrome DevTools Protocol connections to the browser session
    */
@@ -134,6 +130,12 @@ export interface BrowserRetrieveResponse {
    */
   session_id: string;
 
+  /**
+   * Remote URL for live viewing the browser session. Only available for non-headless
+   * browsers.
+   */
+  browser_live_view_url?: string;
+
   /**
    * Optional persistence configuration for the browser session.
    */
@@ -144,11 +146,6 @@ export type BrowserListResponse = Array<BrowserListResponse.BrowserListResponseI
 
 export namespace BrowserListResponse {
   export interface BrowserListResponseItem {
-    /**
-     * Remote URL for live viewing the browser session
-     */
-    browser_live_view_url: string;
-
     /**
      * Websocket URL for Chrome DevTools Protocol connections to the browser session
      */
@@ -159,6 +156,12 @@ export namespace BrowserListResponse {
      */
     session_id: string;
 
+    /**
+     * Remote URL for live viewing the browser session. Only available for non-headless
+     * browsers.
+     */
+    browser_live_view_url?: string;
+
     /**
      * Optional persistence configuration for the browser session.
      */
@@ -167,6 +170,12 @@ export namespace BrowserListResponse {
 }
 
 export interface BrowserCreateParams {
+  /**
+   * If true, launches the browser using a headless image (no VNC/GUI). Defaults to
+   * false.
+   */
+  headless?: boolean;
+
   /**
    * action invocation ID
    */

tests/api-resources/browsers.test.ts

@@ -26,6 +26,7 @@ describe('resource browsers', () => {
     await expect(
       client.browsers.create(
         {
+          headless: false,
           invocation_id: 'rr33xuugxj9h0bkf1rdt2bet',
           persistence: { id: 'my-awesome-browser-for-user-1234' },
           stealth: true,