allow API custom session creation params (#496)

* allow custom session creation params

* missing api url handling

* changeset

Author: sameelarif

Diff for: .changeset/shaggy-planets-fetch.md

@@ -0,0 +1,5 @@
+---
+"@browserbasehq/stagehand": minor
+---
+
+Fixed browserbaseSessionCreateParams not being passed in to the API initialization payload.

Diff for: lib/api.ts

@@ -37,6 +37,7 @@ export class StagehandAPI {
     verbose,
     debugDom,
     systemPrompt,
+    browserbaseSessionCreateParams,
   }: StartSessionParams): Promise<StartSessionResult> {
     const whitelistResponse = await this.request("/healthcheck");
 
@@ -56,6 +57,7 @@ export class StagehandAPI {
         verbose,
         debugDom,
         systemPrompt,
+        browserbaseSessionCreateParams,
       }),
       headers: {
         "x-model-api-key": modelApiKey,

Diff for: lib/index.ts

@@ -393,7 +393,12 @@ export class Stagehand {
 
     if (this.usingAPI && env === "LOCAL") {
       throw new Error("API mode can only be used with BROWSERBASE environment");
+    } else if (this.usingAPI && !process.env.STAGEHAND_API_URL) {
+      throw new Error(
+        "STAGEHAND_API_URL is required when using the API. Please set it in your environment variables.",
+      );
     }
+
     this.selfHeal = selfHeal;
   }
 
@@ -457,6 +462,7 @@ export class Stagehand {
         verbose: this.verbose,
         debugDom: this.debugDom,
         systemPrompt: this.userProvidedInstructions,
+        browserbaseSessionCreateParams: this.browserbaseSessionCreateParams,
       });
       this.browserbaseSessionID = sessionId;
     }

Diff for: types/api.ts

@@ -1,3 +1,4 @@
+import Browserbase from "@browserbasehq/sdk";
 import { LogLine } from "./log";
 
 export interface StagehandAPIConstructorParams {
@@ -19,6 +20,7 @@ export interface StartSessionParams {
   verbose: number;
   debugDom: boolean;
   systemPrompt?: string;
+  browserbaseSessionCreateParams?: Browserbase.Sessions.SessionCreateParams;
 }
 
 export interface StartSessionResult {