feat(api): allow setting a custom name on a browser session at create time

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 117
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e6c711f0d29a7d956cc8ca621440da966c1f1575b1205d01328b1099edf1c517.yml
-openapi_spec_hash: c06e7e36de1c6f9b29b54a6e3dc08ee5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e7925f5cb9626a47fd24470851ff4149c27bc89795f75e8641c618fff93a076c.yml
+openapi_spec_hash: 955d4bf81e9838b0732c0e52716a2030
 config_hash: 36159c262d293fbeacf513ab600a1729

src/kernel/resources/browsers/browsers.py

@@ -169,6 +169,7 @@ def create(
         headless: bool | Omit = omit,
         invocation_id: str | Omit = omit,
         kiosk_mode: bool | Omit = omit,
+        name: str | Omit = omit,
         profile: BrowserProfile | Omit = omit,
         proxy_id: str | Omit = omit,
         start_url: str | Omit = omit,
@@ -205,6 +206,10 @@ def create(
           kiosk_mode: If true, launches the browser in kiosk mode to hide address bar and tabs in live
               view.
 
+          name: Optional human-readable name for the browser session, used to find it later in
+              the dashboard. Must be unique among active sessions within the project. Set at
+              creation time only.
+
           profile: Profile selection for the browser session. Provide either id or name. If
               specified, the matching profile will be loaded into the browser session.
               Profiles must be created beforehand.
@@ -262,6 +267,7 @@ def create(
                     "headless": headless,
                     "invocation_id": invocation_id,
                     "kiosk_mode": kiosk_mode,
+                    "name": name,
                     "profile": profile,
                     "proxy_id": proxy_id,
                     "start_url": start_url,
@@ -413,7 +419,7 @@ def list(
 
           offset: Number of results to skip. Defaults to 0.
 
-          query: Search browsers by session ID, profile ID, proxy ID, or pool name.
+          query: Search browsers by name, session ID, profile ID, proxy ID, or pool name.
 
           status: Filter sessions by status. "active" returns only active sessions (default),
               "deleted" returns only soft-deleted sessions, "all" returns both.
@@ -717,6 +723,7 @@ async def create(
         headless: bool | Omit = omit,
         invocation_id: str | Omit = omit,
         kiosk_mode: bool | Omit = omit,
+        name: str | Omit = omit,
         profile: BrowserProfile | Omit = omit,
         proxy_id: str | Omit = omit,
         start_url: str | Omit = omit,
@@ -753,6 +760,10 @@ async def create(
           kiosk_mode: If true, launches the browser in kiosk mode to hide address bar and tabs in live
               view.
 
+          name: Optional human-readable name for the browser session, used to find it later in
+              the dashboard. Must be unique among active sessions within the project. Set at
+              creation time only.
+
           profile: Profile selection for the browser session. Provide either id or name. If
               specified, the matching profile will be loaded into the browser session.
               Profiles must be created beforehand.
@@ -810,6 +821,7 @@ async def create(
                     "headless": headless,
                     "invocation_id": invocation_id,
                     "kiosk_mode": kiosk_mode,
+                    "name": name,
                     "profile": profile,
                     "proxy_id": proxy_id,
                     "start_url": start_url,
@@ -961,7 +973,7 @@ def list(
 
           offset: Number of results to skip. Defaults to 0.
 
-          query: Search browsers by session ID, profile ID, proxy ID, or pool name.
+          query: Search browsers by name, session ID, profile ID, proxy ID, or pool name.
 
           status: Filter sessions by status. "active" returns only active sessions (default),
               "deleted" returns only soft-deleted sessions, "all" returns both.

src/kernel/types/browser_create_params.py

@@ -49,6 +49,13 @@ class BrowserCreateParams(TypedDict, total=False):
     view.
     """
 
+    name: str
+    """
+    Optional human-readable name for the browser session, used to find it later in
+    the dashboard. Must be unique among active sessions within the project. Set at
+    creation time only.
+    """
+
     profile: BrowserProfile
     """Profile selection for the browser session.
 

src/kernel/types/browser_create_response.py

@@ -63,6 +63,9 @@ class BrowserCreateResponse(BaseModel):
     kiosk_mode: Optional[bool] = None
     """Whether the browser session is running in kiosk mode."""
 
+    name: Optional[str] = None
+    """Human-readable name of the browser session, if one was set at creation."""
+
     pool: Optional[BrowserPoolRef] = None
     """Browser pool this session was acquired from, if any."""
 

src/kernel/types/browser_list_params.py

@@ -22,7 +22,7 @@ class BrowserListParams(TypedDict, total=False):
     """Number of results to skip. Defaults to 0."""
 
     query: str
-    """Search browsers by session ID, profile ID, proxy ID, or pool name."""
+    """Search browsers by name, session ID, profile ID, proxy ID, or pool name."""
 
     status: Literal["active", "deleted", "all"]
     """Filter sessions by status.

src/kernel/types/browser_list_response.py

@@ -63,6 +63,9 @@ class BrowserListResponse(BaseModel):
     kiosk_mode: Optional[bool] = None
     """Whether the browser session is running in kiosk mode."""
 
+    name: Optional[str] = None
+    """Human-readable name of the browser session, if one was set at creation."""
+
     pool: Optional[BrowserPoolRef] = None
     """Browser pool this session was acquired from, if any."""
 

src/kernel/types/browser_pool_acquire_response.py

@@ -63,6 +63,9 @@ class BrowserPoolAcquireResponse(BaseModel):
     kiosk_mode: Optional[bool] = None
     """Whether the browser session is running in kiosk mode."""
 
+    name: Optional[str] = None
+    """Human-readable name of the browser session, if one was set at creation."""
+
     pool: Optional[BrowserPoolRef] = None
     """Browser pool this session was acquired from, if any."""
 

src/kernel/types/browser_retrieve_response.py

@@ -63,6 +63,9 @@ class BrowserRetrieveResponse(BaseModel):
     kiosk_mode: Optional[bool] = None
     """Whether the browser session is running in kiosk mode."""
 
+    name: Optional[str] = None
+    """Human-readable name of the browser session, if one was set at creation."""
+
     pool: Optional[BrowserPoolRef] = None
     """Browser pool this session was acquired from, if any."""
 

src/kernel/types/browser_update_response.py

@@ -63,6 +63,9 @@ class BrowserUpdateResponse(BaseModel):
     kiosk_mode: Optional[bool] = None
     """Whether the browser session is running in kiosk mode."""
 
+    name: Optional[str] = None
+    """Human-readable name of the browser session, if one was set at creation."""
+
     pool: Optional[BrowserPoolRef] = None
     """Browser pool this session was acquired from, if any."""
 

src/kernel/types/invocation_list_browsers_response.py

@@ -63,6 +63,9 @@ class Browser(BaseModel):
     kiosk_mode: Optional[bool] = None
     """Whether the browser session is running in kiosk mode."""
 
+    name: Optional[str] = None
+    """Human-readable name of the browser session, if one was set at creation."""
+
     pool: Optional[BrowserPoolRef] = None
     """Browser pool this session was acquired from, if any."""