feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 7
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fstagehand-3607b588cab78536eb7de9f6acffe8ddda1d34aebe5910c2147421aa6c16bf22.yml
 openapi_spec_hash: fb507e8d38b4978a5717fbb144197868
-config_hash: 2f1ec44e7e07906e07bdc6e075763da9
+config_hash: fc6606301b5142487a69d296f154b265

README.md

@@ -29,8 +29,9 @@ require "bundler/setup"
 require "stagehand"
 
 stagehand = Stagehand::Client.new(
-  api_key: ENV["STAGEHAND_API_KEY"], # This is the default and can be omitted
-  environment: "dev" # or "production" | "local"; defaults to "production"
+  browserbase_api_key: ENV["BROWSERBASE_API_KEY"], # This is the default and can be omitted
+  browserbase_project_id: ENV["BROWSERBASE_PROJECT_ID"], # This is the default and can be omitted
+  model_api_key: ENV["MODEL_API_KEY"] # This is the default and can be omitted
 )
 
 response = stagehand.sessions.act("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", input: "click the first link on the page")

lib/stagehand/client.rb

@@ -15,18 +15,14 @@ class Client < Stagehand::Internal::Transport::BaseClient
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
-    # rubocop:disable Style/MutableConstant
-    # @type [Hash{Symbol=>String}]
-    ENVIRONMENTS =
-      {
-        production: "https://api.stagehand.browserbase.com/v1",
-        dev: "https://api.stagehand.dev.browserbase.com/v1",
-        local: "http://localhost:5000/v1"
-      }
-    # rubocop:enable Style/MutableConstant
+    # @return [String]
+    attr_reader :browserbase_api_key
 
     # @return [String]
-    attr_reader :api_key
+    attr_reader :browserbase_project_id
+
+    # @return [String, nil]
+    attr_reader :model_api_key
 
     # @return [Stagehand::Resources::Sessions]
     attr_reader :sessions
@@ -35,22 +31,37 @@ class Client < Stagehand::Internal::Transport::BaseClient
     #
     # @return [Hash{String=>String}]
     private def auth_headers
-      return {} if @api_key.nil?
+      {**bb_api_key_auth, **bb_project_id_auth, **llm_model_api_key_auth}
+    end
 
-      {"authorization" => "Bearer #{@api_key}"}
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def bb_api_key_auth
+      {"x-bb-api-key" => @browserbase_api_key}
     end
 
-    # Creates and returns a new client for interacting with the API.
+    # @api private
     #
-    # @param api_key [String, nil] Defaults to `ENV["STAGEHAND_API_KEY"]`
+    # @return [Hash{String=>String}]
+    private def bb_project_id_auth
+      {"x-bb-project-id" => @browserbase_project_id}
+    end
+
+    # @api private
     #
-    # @param environment [:production, :dev, :local, nil] Specifies the environment to use for the API.
+    # @return [Hash{String=>String}]
+    private def llm_model_api_key_auth
+      {"x-model-api-key" => @model_api_key}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param browserbase_api_key [String, nil] Defaults to `ENV["BROWSERBASE_API_KEY"]`
     #
-    # Each environment maps to a different base URL:
+    # @param browserbase_project_id [String, nil] Defaults to `ENV["BROWSERBASE_PROJECT_ID"]`
     #
-    # - `production` corresponds to `https://api.stagehand.browserbase.com/v1`
-    # - `dev` corresponds to `https://api.stagehand.dev.browserbase.com/v1`
-    # - `local` corresponds to `http://localhost:5000/v1`
+    # @param model_api_key [String, nil] Defaults to `ENV["MODEL_API_KEY"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["STAGEHAND_BASE_URL"]`
@@ -63,24 +74,27 @@ class Client < Stagehand::Internal::Transport::BaseClient
     #
     # @param max_retry_delay [Float]
     def initialize(
-      api_key: ENV["STAGEHAND_API_KEY"],
-      environment: nil,
+      browserbase_api_key: ENV["BROWSERBASE_API_KEY"],
+      browserbase_project_id: ENV["BROWSERBASE_PROJECT_ID"],
+      model_api_key: ENV["MODEL_API_KEY"],
       base_url: ENV["STAGEHAND_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
-      base_url ||= Stagehand::Client::ENVIRONMENTS.fetch(environment&.to_sym || :production) do
-        message = "environment must be one of #{Stagehand::Client::ENVIRONMENTS.keys}, got #{environment}"
-        raise ArgumentError.new(message)
-      end
+      base_url ||= "https://api.stagehand.browserbase.com/v1"
 
-      if api_key.nil?
-        raise ArgumentError.new("api_key is required, and can be set via environ: \"STAGEHAND_API_KEY\"")
+      if browserbase_api_key.nil?
+        raise ArgumentError.new("browserbase_api_key is required, and can be set via environ: \"BROWSERBASE_API_KEY\"")
+      end
+      if browserbase_project_id.nil?
+        raise ArgumentError.new("browserbase_project_id is required, and can be set via environ: \"BROWSERBASE_PROJECT_ID\"")
       end
 
-      @api_key = api_key.to_s
+      @browserbase_api_key = browserbase_api_key.to_s
+      @browserbase_project_id = browserbase_project_id.to_s
+      @model_api_key = model_api_key&.to_s
 
       super(
         base_url: base_url,

rbi/stagehand/client.rbi

@@ -10,18 +10,14 @@ module Stagehand
 
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
-    ENVIRONMENTS =
-      T.let(
-        {
-          production: "https://api.stagehand.browserbase.com/v1",
-          dev: "https://api.stagehand.dev.browserbase.com/v1",
-          local: "http://localhost:5000/v1"
-        },
-        T::Hash[Symbol, String]
-      )
+    sig { returns(String) }
+    attr_reader :browserbase_api_key
 
     sig { returns(String) }
-    attr_reader :api_key
+    attr_reader :browserbase_project_id
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :model_api_key
 
     sig { returns(Stagehand::Resources::Sessions) }
     attr_reader :sessions
@@ -31,11 +27,27 @@ module Stagehand
     private def auth_headers
     end
 
+    # @api private
+    sig { returns(T::Hash[String, String]) }
+    private def bb_api_key_auth
+    end
+
+    # @api private
+    sig { returns(T::Hash[String, String]) }
+    private def bb_project_id_auth
+    end
+
+    # @api private
+    sig { returns(T::Hash[String, String]) }
+    private def llm_model_api_key_auth
+    end
+
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
-        api_key: T.nilable(String),
-        environment: T.nilable(T.any(Symbol, String)),
+        browserbase_api_key: T.nilable(String),
+        browserbase_project_id: T.nilable(String),
+        model_api_key: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -44,16 +56,12 @@ module Stagehand
       ).returns(T.attached_class)
     end
     def self.new(
-      # Defaults to `ENV["STAGEHAND_API_KEY"]`
-      api_key: ENV["STAGEHAND_API_KEY"],
-      # Specifies the environment to use for the API.
-      #
-      # Each environment maps to a different base URL:
-      #
-      # - `production` corresponds to `https://api.stagehand.browserbase.com/v1`
-      # - `dev` corresponds to `https://api.stagehand.dev.browserbase.com/v1`
-      # - `local` corresponds to `http://localhost:5000/v1`
-      environment: nil,
+      # Defaults to `ENV["BROWSERBASE_API_KEY"]`
+      browserbase_api_key: ENV["BROWSERBASE_API_KEY"],
+      # Defaults to `ENV["BROWSERBASE_PROJECT_ID"]`
+      browserbase_project_id: ENV["BROWSERBASE_PROJECT_ID"],
+      # Defaults to `ENV["MODEL_API_KEY"]`
+      model_api_key: ENV["MODEL_API_KEY"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["STAGEHAND_BASE_URL"]`
       base_url: ENV["STAGEHAND_BASE_URL"],

sig/stagehand/client.rbs

@@ -8,21 +8,26 @@ module Stagehand
 
     DEFAULT_MAX_RETRY_DELAY: Float
 
-    ENVIRONMENTS: {
-      production: "https://api.stagehand.browserbase.com/v1",
-      dev: "https://api.stagehand.dev.browserbase.com/v1",
-      local: "http://localhost:5000/v1"
-    }
+    attr_reader browserbase_api_key: String
 
-    attr_reader api_key: String
+    attr_reader browserbase_project_id: String
+
+    attr_reader model_api_key: String?
 
     attr_reader sessions: Stagehand::Resources::Sessions
 
     private def auth_headers: -> ::Hash[String, String]
 
+    private def bb_api_key_auth: -> ::Hash[String, String]
+
+    private def bb_project_id_auth: -> ::Hash[String, String]
+
+    private def llm_model_api_key_auth: -> ::Hash[String, String]
+
     def initialize: (
-      ?api_key: String?,
-      ?environment: :production | :dev | :local | nil,
+      ?browserbase_api_key: String?,
+      ?browserbase_project_id: String?,
+      ?model_api_key: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,