STG-1808: Deprecate browserbase project ID (#75)

* Deprecate browserbase project ID

* Fix CI formatting

---------

Co-authored-by: samfinton <samfinton@samLaptopm5.galaxus.box>

Author: 2 people

README.md

@@ -96,7 +96,7 @@ namespace Stagehand.Examples
         static async Task Main(string[] args)
         {
             Env.Load();
-            // Uses environment variables: STAGEHAND_API_URL, BROWSERBASE_API_KEY, BROWSERBASE_PROJECT_ID, MODEL_API_KEY
+            // Uses environment variables: BROWSERBASE_API_KEY and MODEL_API_KEY
             StagehandClient client = new();
 
             // Start a new remote Browserbase session (Playwright-backed)
@@ -325,10 +325,8 @@ namespace Stagehand.Examples
 
 Set your environment variables (from `examples/.env.example`):
 
-- `STAGEHAND_API_URL`
 - `MODEL_API_KEY`
 - `BROWSERBASE_API_KEY`
-- `BROWSERBASE_PROJECT_ID`
 
 ```bash
 cp examples/.env.example examples/.env
@@ -373,7 +371,7 @@ Configure the client using environment variables:
 ```csharp
 using Stagehand;
 
-// Configured using the BROWSERBASE_API_KEY, BROWSERBASE_PROJECT_ID, MODEL_API_KEY and STAGEHAND_API_URL environment variables
+// Configured using BROWSERBASE_API_KEY, MODEL_API_KEY, and STAGEHAND_API_URL, with STAGEHAND_BASE_URL as a fallback
 StagehandClient client = new();
 ```
 
@@ -385,7 +383,6 @@ using Stagehand;
 StagehandClient client = new()
 {
     BrowserbaseApiKey = "My Browserbase API Key",
-    BrowserbaseProjectID = "My Browserbase Project ID",
     ModelApiKey = "My Model API Key",
 };
 ```
@@ -397,9 +394,11 @@ See this table for the available options:
 | Property               | Environment variable     | Required | Default value                             |
 | ---------------------- | ------------------------ | -------- | ----------------------------------------- |
 | `BrowserbaseApiKey`    | `BROWSERBASE_API_KEY`    | true     | -                                         |
-| `BrowserbaseProjectID` | `BROWSERBASE_PROJECT_ID` | false    | -                                         |
+| `BrowserbaseProjectID` | -                        | false    | -                                         |
 | `ModelApiKey`          | `MODEL_API_KEY`          | true     | -                                         |
-| `BaseUrl`              | `STAGEHAND_API_URL`     | true     | `"https://api.stagehand.browserbase.com"` |
+| `BaseUrl`              | `STAGEHAND_API_URL`      | false    | `"https://api.stagehand.browserbase.com"` |
+
+`BrowserbaseProjectID` is deprecated, accepted for backwards compatibility, and ignored. `STAGEHAND_BASE_URL` remains supported as a deprecated fallback when `STAGEHAND_API_URL` is unset.
 
 ### Modifying configuration
 

examples/.env.example

@@ -1,4 +1,2 @@
-STAGEHAND_API_URL=https://api.stagehand.browserbase.com
 MODEL_API_KEY=sk-proj-your-llm-api-key-here
 BROWSERBASE_API_KEY=bb_live_your_api_key_here
-BROWSERBASE_PROJECT_ID=your-bb-project-uuid-here

examples/Env.cs

@@ -6,13 +6,7 @@ namespace Stagehand.Examples
 {
     internal static class Env
     {
-        private static readonly string[] RequiredKeys =
-        [
-            "STAGEHAND_API_URL",
-            "MODEL_API_KEY",
-            "BROWSERBASE_API_KEY",
-            "BROWSERBASE_PROJECT_ID",
-        ];
+        private static readonly string[] RequiredKeys = ["MODEL_API_KEY", "BROWSERBASE_API_KEY"];
 
         public static void Load()
         {

examples/local_browser_playwright_example.cs

@@ -17,7 +17,7 @@ public static async Task RunAsync()
         {
             Env.Load();
             // Uses environment variables: MODEL_API_KEY
-            // In local mode, BROWSERBASE_API_KEY and BROWSERBASE_PROJECT_ID can be any value.
+            // In local mode, BROWSERBASE_API_KEY can be any value.
             StagehandClient client = new();
 
             // Start a new local session

examples/local_server_multiregion_browser_example.cs

@@ -16,8 +16,8 @@ internal static class LocalServerMultiregionBrowserExample
         public static async Task RunAsync()
         {
             Env.Load();
-            // Uses environment variables: BROWSERBASE_API_KEY, BROWSERBASE_PROJECT_ID, MODEL_API_KEY
-            // STAGEHAND_API_URL should point to the local Stagehand server.
+            // Uses environment variables: BROWSERBASE_API_KEY and MODEL_API_KEY
+            // STAGEHAND_API_URL should point to the local Stagehand server; STAGEHAND_BASE_URL is a fallback.
             StagehandClient client = new();
 
             var startResponse = await client.Sessions.Start(

examples/remote_browser_playwright_example.cs

@@ -16,7 +16,7 @@ internal static class RemoteBrowserPlaywrightExample
         public static async Task RunAsync()
         {
             Env.Load();
-            // Uses environment variables: BROWSERBASE_API_KEY, BROWSERBASE_PROJECT_ID, MODEL_API_KEY
+            // Uses environment variables: BROWSERBASE_API_KEY and MODEL_API_KEY
             StagehandClient client = new();
 
             // Start a new remote Browserbase session (Playwright-backed)

src/Stagehand/Core/ClientOptions.cs

@@ -110,13 +110,11 @@ public string BrowserbaseApiKey
     /// Deprecated. Browserbase API keys are now project-scoped, so this value is
     /// no longer required.
     /// </summary>
-    Lazy<string?> _browserbaseProjectID = new(() =>
-        Environment.GetEnvironmentVariable("BROWSERBASE_PROJECT_ID")
-    );
+    Lazy<string?> _browserbaseProjectID = new(() => null);
 
     /// <summary>
     /// Deprecated. Browserbase API keys are now project-scoped, so this value is
-    /// no longer required.
+    /// no longer required. Accepted for backwards compatibility; it is not sent to the API.
     /// </summary>
     public string? BrowserbaseProjectID
     {

src/Stagehand/Core/ParamsBase.cs

@@ -215,10 +215,6 @@ internal static void AddDefaultHeaders(HttpRequestMessage request, ClientOptions
         {
             request.Headers.Add("x-bb-api-key", options.BrowserbaseApiKey);
         }
-        if (options.BrowserbaseProjectID != null)
-        {
-            request.Headers.Add("x-bb-project-id", options.BrowserbaseProjectID);
-        }
         if (options.ModelApiKey != null)
         {
             request.Headers.Add("x-model-api-key", options.ModelApiKey);

src/Stagehand/IStagehandClient.cs

@@ -43,7 +43,7 @@ public interface IStagehandClient : IDisposable
 
     /// <summary>
     /// Deprecated. Browserbase API keys are now project-scoped, so this value is
-    /// no longer required.
+    /// no longer required. Accepted for backwards compatibility; it is not sent to the API.
     /// </summary>
     string? BrowserbaseProjectID { get; init; }
 
@@ -95,7 +95,7 @@ public interface IStagehandClientWithRawResponse : IDisposable
 
     /// <summary>
     /// Deprecated. Browserbase API keys are now project-scoped, so this value is
-    /// no longer required.
+    /// no longer required. Accepted for backwards compatibility; it is not sent to the API.
     /// </summary>
     string? BrowserbaseProjectID { get; init; }