feat: Allow auto-starting replays during browser creation and pool acquire

Stainless-Generated-From: 2dedcf550acbb3d29238c71dc117c2de12cac94b

Author: kernel-internal[bot]

src/kernel/resources/browser_pools.py

@@ -78,6 +78,7 @@ def create(
         proxy_id: str | Omit = omit,
         refresh_on_profile_update: bool | Omit = omit,
         region: Literal["us-east", "us-west", "eu-west", "ap-southeast"] | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         stealth: bool | Omit = omit,
         telemetry: Optional[browser_pool_create_params.Telemetry] | Omit = omit,
@@ -146,6 +147,8 @@ def create(
               Region selection requires a Start-Up or Enterprise plan, defaults to us-east
               when omitted on create.
 
+          start_replay: Start replay recording automatically when a browser is acquired from this pool.
+
           start_url: Optional URL to navigate to when a new browser is warmed into the pool.
               Best-effort: failures to navigate do not fail pool fill. Only applied to
               newly-warmed browsers; browsers reused via release/acquire keep whatever URL the
@@ -205,6 +208,7 @@ def create(
                     "proxy_id": proxy_id,
                     "refresh_on_profile_update": refresh_on_profile_update,
                     "region": region,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "stealth": stealth,
                     "telemetry": telemetry,
@@ -274,6 +278,7 @@ def update(
         proxy_id: str | Omit = omit,
         refresh_on_profile_update: bool | Omit = omit,
         size: int | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         stealth: bool | Omit = omit,
         telemetry: Optional[browser_pool_update_params.Telemetry] | Omit = omit,
@@ -368,6 +373,9 @@ def update(
               maximum size is determined by your organization's pooled sessions limit (the sum
               of all pool sizes cannot exceed your limit).
 
+          start_replay: If provided, replaces whether replay recording starts automatically for future
+              acquired browsers.
+
           start_url: If provided, replaces the URL to navigate to when a new browser is warmed into
               the pool. Empty string clears the previously-set URL. Omit this field to leave
               it unchanged.
@@ -428,6 +436,7 @@ def update(
                     "proxy_id": proxy_id,
                     "refresh_on_profile_update": refresh_on_profile_update,
                     "size": size,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "stealth": stealth,
                     "telemetry": telemetry,
@@ -564,6 +573,7 @@ def acquire(
         acquire_timeout_seconds: int | Omit = omit,
         name: str | Omit = omit,
         profile: BrowserProfile | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         tags: TagsParam | Omit = omit,
         telemetry: Optional[browser_pool_acquire_params.Telemetry] | Omit = omit,
@@ -596,6 +606,9 @@ def acquire(
               specified, the matching profile will be loaded into the browser session.
               Profiles must be created beforehand.
 
+          start_replay: Start replay recording immediately for the acquired browser. Omit to use the
+              pool's configured default.
+
           start_url: Optional URL to navigate the acquired browser to. Overrides the pool's start_url
               for this acquire only. Best-effort: failures to navigate do not fail the
               acquire.
@@ -632,6 +645,7 @@ def acquire(
                     "acquire_timeout_seconds": acquire_timeout_seconds,
                     "name": name,
                     "profile": profile,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "tags": tags,
                     "telemetry": telemetry,
@@ -787,6 +801,7 @@ async def create(
         proxy_id: str | Omit = omit,
         refresh_on_profile_update: bool | Omit = omit,
         region: Literal["us-east", "us-west", "eu-west", "ap-southeast"] | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         stealth: bool | Omit = omit,
         telemetry: Optional[browser_pool_create_params.Telemetry] | Omit = omit,
@@ -855,6 +870,8 @@ async def create(
               Region selection requires a Start-Up or Enterprise plan, defaults to us-east
               when omitted on create.
 
+          start_replay: Start replay recording automatically when a browser is acquired from this pool.
+
           start_url: Optional URL to navigate to when a new browser is warmed into the pool.
               Best-effort: failures to navigate do not fail pool fill. Only applied to
               newly-warmed browsers; browsers reused via release/acquire keep whatever URL the
@@ -914,6 +931,7 @@ async def create(
                     "proxy_id": proxy_id,
                     "refresh_on_profile_update": refresh_on_profile_update,
                     "region": region,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "stealth": stealth,
                     "telemetry": telemetry,
@@ -983,6 +1001,7 @@ async def update(
         proxy_id: str | Omit = omit,
         refresh_on_profile_update: bool | Omit = omit,
         size: int | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         stealth: bool | Omit = omit,
         telemetry: Optional[browser_pool_update_params.Telemetry] | Omit = omit,
@@ -1077,6 +1096,9 @@ async def update(
               maximum size is determined by your organization's pooled sessions limit (the sum
               of all pool sizes cannot exceed your limit).
 
+          start_replay: If provided, replaces whether replay recording starts automatically for future
+              acquired browsers.
+
           start_url: If provided, replaces the URL to navigate to when a new browser is warmed into
               the pool. Empty string clears the previously-set URL. Omit this field to leave
               it unchanged.
@@ -1137,6 +1159,7 @@ async def update(
                     "proxy_id": proxy_id,
                     "refresh_on_profile_update": refresh_on_profile_update,
                     "size": size,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "stealth": stealth,
                     "telemetry": telemetry,
@@ -1273,6 +1296,7 @@ async def acquire(
         acquire_timeout_seconds: int | Omit = omit,
         name: str | Omit = omit,
         profile: BrowserProfile | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         tags: TagsParam | Omit = omit,
         telemetry: Optional[browser_pool_acquire_params.Telemetry] | Omit = omit,
@@ -1305,6 +1329,9 @@ async def acquire(
               specified, the matching profile will be loaded into the browser session.
               Profiles must be created beforehand.
 
+          start_replay: Start replay recording immediately for the acquired browser. Omit to use the
+              pool's configured default.
+
           start_url: Optional URL to navigate the acquired browser to. Overrides the pool's start_url
               for this acquire only. Best-effort: failures to navigate do not fail the
               acquire.
@@ -1341,6 +1368,7 @@ async def acquire(
                     "acquire_timeout_seconds": acquire_timeout_seconds,
                     "name": name,
                     "profile": profile,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "tags": tags,
                     "telemetry": telemetry,

src/kernel/resources/browsers/browsers.py

@@ -209,6 +209,7 @@ def create(
         proxy: BrowserProxyConfigParam | Omit = omit,
         proxy_id: str | Omit = omit,
         region: Literal["us-east", "us-west", "eu-west", "ap-southeast"] | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         stealth: bool | Omit = omit,
         tags: TagsParam | Omit = omit,
@@ -285,6 +286,8 @@ def create(
               created. Region selection requires a Start-Up or Enterprise plan, defaults to
               us-east when omitted on create.
 
+          start_replay: Start replay recording as part of creating this browser session.
+
           start_url: Optional URL to open when the browser session is created. Navigation is
               best-effort, so navigation failures do not prevent the session from being
               created.
@@ -360,6 +363,7 @@ def create(
                     "proxy": proxy,
                     "proxy_id": proxy_id,
                     "region": region,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "stealth": stealth,
                     "tags": tags,
@@ -1070,6 +1074,7 @@ async def create(
         proxy: BrowserProxyConfigParam | Omit = omit,
         proxy_id: str | Omit = omit,
         region: Literal["us-east", "us-west", "eu-west", "ap-southeast"] | Omit = omit,
+        start_replay: bool | Omit = omit,
         start_url: str | Omit = omit,
         stealth: bool | Omit = omit,
         tags: TagsParam | Omit = omit,
@@ -1146,6 +1151,8 @@ async def create(
               created. Region selection requires a Start-Up or Enterprise plan, defaults to
               us-east when omitted on create.
 
+          start_replay: Start replay recording as part of creating this browser session.
+
           start_url: Optional URL to open when the browser session is created. Navigation is
               best-effort, so navigation failures do not prevent the session from being
               created.
@@ -1221,6 +1228,7 @@ async def create(
                     "proxy": proxy,
                     "proxy_id": proxy_id,
                     "region": region,
+                    "start_replay": start_replay,
                     "start_url": start_url,
                     "stealth": stealth,
                     "tags": tags,

src/kernel/types/browser_create_params.py

@@ -132,6 +132,9 @@ class BrowserCreateParams(TypedDict, total=False):
     Enterprise plan, defaults to us-east when omitted on create.
     """
 
+    start_replay: bool
+    """Start replay recording as part of creating this browser session."""
+
     start_url: str
     """Optional URL to open when the browser session is created.
 

src/kernel/types/browser_pool.py

@@ -108,6 +108,9 @@ class BrowserPoolConfig(BaseModel):
     creation, this defaults to true. Requires a profile to be set on the pool.
     """
 
+    start_replay: Optional[bool] = None
+    """Start replay recording automatically when a browser is acquired from this pool."""
+
     start_url: Optional[str] = None
     """Optional URL to navigate to when a new browser is warmed into the pool.
 

src/kernel/types/browser_pool_acquire_params.py

@@ -42,6 +42,12 @@ class BrowserPoolAcquireParams(TypedDict, total=False):
     into the browser session. Profiles must be created beforehand.
     """
 
+    start_replay: bool
+    """Start replay recording immediately for the acquired browser.
+
+    Omit to use the pool's configured default.
+    """
+
     start_url: str
     """Optional URL to navigate the acquired browser to.
 

src/kernel/types/browser_pool_create_params.py

@@ -106,6 +106,9 @@ class BrowserPoolCreateParams(TypedDict, total=False):
     Enterprise plan, defaults to us-east when omitted on create.
     """
 
+    start_replay: bool
+    """Start replay recording automatically when a browser is acquired from this pool."""
+
     start_url: str
     """Optional URL to navigate to when a new browser is warmed into the pool.
 

src/kernel/types/browser_pool_update_params.py

@@ -135,6 +135,12 @@ class BrowserPoolUpdateParams(TypedDict, total=False):
     sum of all pool sizes cannot exceed your limit).
     """
 
+    start_replay: bool
+    """
+    If provided, replaces whether replay recording starts automatically for future
+    acquired browsers.
+    """
+
     start_url: str
     """
     If provided, replaces the URL to navigate to when a new browser is warmed into

tests/api_resources/test_browser_pools.py

@@ -66,6 +66,7 @@ def test_method_create_with_all_params(self, client: Kernel) -> None:
             proxy_id="proxy_id",
             refresh_on_profile_update=True,
             region="us-east",
+            start_replay=True,
             start_url="https://example.com",
             stealth=True,
             telemetry={
@@ -232,6 +233,7 @@ def test_method_update_with_all_params(self, client: Kernel) -> None:
             proxy_id="proxy_id",
             refresh_on_profile_update=True,
             size=10,
+            start_replay=True,
             start_url="https://example.com",
             stealth=True,
             telemetry={
@@ -416,6 +418,7 @@ def test_method_acquire_with_all_params(self, client: Kernel) -> None:
                 "name": "name",
                 "save_changes": True,
             },
+            start_replay=True,
             start_url="https://example.com",
             tags={
                 "team": "backend",
@@ -635,6 +638,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncKernel) ->
             proxy_id="proxy_id",
             refresh_on_profile_update=True,
             region="us-east",
+            start_replay=True,
             start_url="https://example.com",
             stealth=True,
             telemetry={
@@ -801,6 +805,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncKernel) ->
             proxy_id="proxy_id",
             refresh_on_profile_update=True,
             size=10,
+            start_replay=True,
             start_url="https://example.com",
             stealth=True,
             telemetry={
@@ -985,6 +990,7 @@ async def test_method_acquire_with_all_params(self, async_client: AsyncKernel) -
                 "name": "name",
                 "save_changes": True,
             },
+            start_replay=True,
             start_url="https://example.com",
             tags={
                 "team": "backend",

tests/api_resources/test_browsers.py

@@ -79,6 +79,7 @@ def test_method_create_with_all_params(self, client: Kernel) -> None:
             },
             proxy_id="proxy_id",
             region="us-east",
+            start_replay=True,
             start_url="https://example.com",
             stealth=True,
             tags={
@@ -691,6 +692,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncKernel) ->
             },
             proxy_id="proxy_id",
             region="us-east",
+            start_replay=True,
             start_url="https://example.com",
             stealth=True,
             tags={