feat: Bedrock auth passthrough

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 8
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fstagehand-b969ce378479c79ee64c05127c0ed6c6ce2edbee017ecd037242fb618a5ebc9f.yml
-openapi_spec_hash: a24aabaa5214effb679808b7f2be0ad4
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fstagehand-7773ef4ca29c983daafb787ee918cfa6b5b12c5bbdc088308653f2737c26e51f.yml
+openapi_spec_hash: 47fc8f2540be0b6374e4230c021072d9
 config_hash: 0cc516caf1432087f40654336e0fa8cd

lib/stagehand/models/model_config.rb

@@ -22,7 +22,7 @@ class ModelConfig < Stagehand::Internal::Type::BaseModel
       optional :base_url, String, api_name: :baseURL
 
       # @!attribute headers
-      #   Custom headers sent with every request to the model provider
+      #   Custom headers for the model provider
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :headers, Stagehand::Internal::Type::HashOf[String]
@@ -33,16 +33,40 @@ class ModelConfig < Stagehand::Internal::Type::BaseModel
       #   @return [Symbol, Stagehand::Models::ModelConfig::Provider, nil]
       optional :provider, enum: -> { Stagehand::ModelConfig::Provider }
 
-      # @!method initialize(model_name:, api_key: nil, base_url: nil, headers: nil, provider: nil)
+      # @!attribute provider_options
+      #   Provider-specific options passed through to the AI SDK provider constructor. For
+      #   Bedrock: { region, accessKeyId, secretAccessKey, sessionToken }. For Vertex: {
+      #   project, location, googleAuthOptions }.
+      #
+      #   @return [Stagehand::Models::ModelConfig::ProviderOptions::BedrockAPIKeyProviderOptions, Stagehand::Models::ModelConfig::ProviderOptions::BedrockAwsCredentialsProviderOptions, Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions, nil]
+      optional :provider_options,
+               union: -> { Stagehand::ModelConfig::ProviderOptions },
+               api_name: :providerOptions
+
+      # @!attribute skip_api_key_fallback
+      #   When true, hosted sessions will not copy x-model-api-key into model.apiKey. Use
+      #   this when auth is carried through providerOptions instead of an API key.
+      #
+      #   @return [Boolean, nil]
+      optional :skip_api_key_fallback, Stagehand::Internal::Type::Boolean, api_name: :skipApiKeyFallback
+
+      # @!method initialize(model_name:, api_key: nil, base_url: nil, headers: nil, provider: nil, provider_options: nil, skip_api_key_fallback: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Stagehand::Models::ModelConfig} for more details.
+      #
       #   @param model_name [String] Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
       #
       #   @param api_key [String] API key for the model provider
       #
       #   @param base_url [String] Base URL for the model provider
       #
-      #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the model provider
+      #   @param headers [Hash{Symbol=>String}] Custom headers for the model provider
       #
       #   @param provider [Symbol, Stagehand::Models::ModelConfig::Provider] AI provider for the model (or provide a baseURL endpoint instead)
+      #
+      #   @param provider_options [Stagehand::Models::ModelConfig::ProviderOptions::BedrockAPIKeyProviderOptions, Stagehand::Models::ModelConfig::ProviderOptions::BedrockAwsCredentialsProviderOptions, Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions] Provider-specific options passed through to the AI SDK provider constructor. For
+      #
+      #   @param skip_api_key_fallback [Boolean] When true, hosted sessions will not copy x-model-api-key into model.apiKey. Use
 
       # AI provider for the model (or provide a baseURL endpoint instead)
       #
@@ -59,6 +83,194 @@ module Provider
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # Provider-specific options passed through to the AI SDK provider constructor. For
+      # Bedrock: { region, accessKeyId, secretAccessKey, sessionToken }. For Vertex: {
+      # project, location, googleAuthOptions }.
+      #
+      # @see Stagehand::Models::ModelConfig#provider_options
+      module ProviderOptions
+        extend Stagehand::Internal::Type::Union
+
+        variant -> { Stagehand::ModelConfig::ProviderOptions::BedrockAPIKeyProviderOptions }
+
+        variant -> { Stagehand::ModelConfig::ProviderOptions::BedrockAwsCredentialsProviderOptions }
+
+        variant -> { Stagehand::ModelConfig::ProviderOptions::GoogleVertexProviderOptions }
+
+        class BedrockAPIKeyProviderOptions < Stagehand::Internal::Type::BaseModel
+          # @!attribute region
+          #   AWS region for Amazon Bedrock
+          #
+          #   @return [String]
+          required :region, String
+
+          # @!method initialize(region:)
+          #   @param region [String] AWS region for Amazon Bedrock
+        end
+
+        class BedrockAwsCredentialsProviderOptions < Stagehand::Internal::Type::BaseModel
+          # @!attribute access_key_id
+          #   AWS access key ID for Bedrock
+          #
+          #   @return [String]
+          required :access_key_id, String, api_name: :accessKeyId
+
+          # @!attribute region
+          #   AWS region for Amazon Bedrock
+          #
+          #   @return [String]
+          required :region, String
+
+          # @!attribute secret_access_key
+          #   AWS secret access key for Bedrock
+          #
+          #   @return [String]
+          required :secret_access_key, String, api_name: :secretAccessKey
+
+          # @!attribute session_token
+          #   Optional AWS session token for temporary credentials
+          #
+          #   @return [String, nil]
+          optional :session_token, String, api_name: :sessionToken
+
+          # @!method initialize(access_key_id:, region:, secret_access_key:, session_token: nil)
+          #   @param access_key_id [String] AWS access key ID for Bedrock
+          #
+          #   @param region [String] AWS region for Amazon Bedrock
+          #
+          #   @param secret_access_key [String] AWS secret access key for Bedrock
+          #
+          #   @param session_token [String] Optional AWS session token for temporary credentials
+        end
+
+        class GoogleVertexProviderOptions < Stagehand::Internal::Type::BaseModel
+          # @!attribute google_auth_options
+          #   Optional Google auth options for Vertex AI
+          #
+          #   @return [Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions::GoogleAuthOptions, nil]
+          optional :google_auth_options,
+                   -> {
+                     Stagehand::ModelConfig::ProviderOptions::GoogleVertexProviderOptions::GoogleAuthOptions
+                   },
+                   api_name: :googleAuthOptions
+
+          # @!attribute headers
+          #   Custom headers for Vertex AI requests
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :headers, Stagehand::Internal::Type::HashOf[String]
+
+          # @!attribute location
+          #   Google Cloud location for Vertex AI
+          #
+          #   @return [String, nil]
+          optional :location, String
+
+          # @!attribute project
+          #   Google Cloud project ID for Vertex AI
+          #
+          #   @return [String, nil]
+          optional :project, String
+
+          # @!method initialize(google_auth_options: nil, headers: nil, location: nil, project: nil)
+          #   @param google_auth_options [Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions::GoogleAuthOptions] Optional Google auth options for Vertex AI
+          #
+          #   @param headers [Hash{Symbol=>String}] Custom headers for Vertex AI requests
+          #
+          #   @param location [String] Google Cloud location for Vertex AI
+          #
+          #   @param project [String] Google Cloud project ID for Vertex AI
+
+          # @see Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions#google_auth_options
+          class GoogleAuthOptions < Stagehand::Internal::Type::BaseModel
+            # @!attribute credentials
+            #
+            #   @return [Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions::GoogleAuthOptions::Credentials, nil]
+            optional :credentials,
+                     -> { Stagehand::ModelConfig::ProviderOptions::GoogleVertexProviderOptions::GoogleAuthOptions::Credentials }
+
+            # @!method initialize(credentials: nil)
+            #   Optional Google auth options for Vertex AI
+            #
+            #   @param credentials [Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions::GoogleAuthOptions::Credentials]
+
+            # @see Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions::GoogleAuthOptions#credentials
+            class Credentials < Stagehand::Internal::Type::BaseModel
+              # @!attribute auth_provider_x509_cert_url
+              #
+              #   @return [String, nil]
+              optional :auth_provider_x509_cert_url, String
+
+              # @!attribute auth_uri
+              #
+              #   @return [String, nil]
+              optional :auth_uri, String
+
+              # @!attribute client_email
+              #
+              #   @return [String, nil]
+              optional :client_email, String
+
+              # @!attribute client_id
+              #
+              #   @return [String, nil]
+              optional :client_id, String
+
+              # @!attribute client_x509_cert_url
+              #
+              #   @return [String, nil]
+              optional :client_x509_cert_url, String
+
+              # @!attribute private_key
+              #
+              #   @return [String, nil]
+              optional :private_key, String
+
+              # @!attribute private_key_id
+              #
+              #   @return [String, nil]
+              optional :private_key_id, String
+
+              # @!attribute project_id
+              #
+              #   @return [String, nil]
+              optional :project_id, String
+
+              # @!attribute token_uri
+              #
+              #   @return [String, nil]
+              optional :token_uri, String
+
+              # @!attribute type
+              #
+              #   @return [String, nil]
+              optional :type, String
+
+              # @!attribute universe_domain
+              #
+              #   @return [String, nil]
+              optional :universe_domain, String
+
+              # @!method initialize(auth_provider_x509_cert_url: nil, auth_uri: nil, client_email: nil, client_id: nil, client_x509_cert_url: nil, private_key: nil, private_key_id: nil, project_id: nil, token_uri: nil, type: nil, universe_domain: nil)
+              #   @param auth_provider_x509_cert_url [String]
+              #   @param auth_uri [String]
+              #   @param client_email [String]
+              #   @param client_id [String]
+              #   @param client_x509_cert_url [String]
+              #   @param private_key [String]
+              #   @param private_key_id [String]
+              #   @param project_id [String]
+              #   @param token_uri [String]
+              #   @param type [String]
+              #   @param universe_domain [String]
+            end
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(Stagehand::Models::ModelConfig::ProviderOptions::BedrockAPIKeyProviderOptions, Stagehand::Models::ModelConfig::ProviderOptions::BedrockAwsCredentialsProviderOptions, Stagehand::Models::ModelConfig::ProviderOptions::GoogleVertexProviderOptions)]
+      end
     end
   end
 end

lib/stagehand/models/session_execute_params.rb

@@ -198,28 +198,12 @@ class ExecuteOptions < Stagehand::Internal::Type::BaseModel
         #   @return [Float, nil]
         optional :max_steps, Float, api_name: :maxSteps
 
-        # @!attribute tool_timeout
-        #   Timeout in milliseconds for each agent tool call
-        #
-        #   @return [Float, nil]
-        optional :tool_timeout, Float, api_name: :toolTimeout
-
-        # @!attribute use_search
-        #   Whether to enable the web search tool powered by Browserbase Search API
-        #
-        #   @return [Boolean, nil]
-        optional :use_search, Stagehand::Internal::Type::Boolean, api_name: :useSearch
-
-        # @!method initialize(instruction:, highlight_cursor: nil, max_steps: nil, tool_timeout: nil, use_search: nil)
+        # @!method initialize(instruction:, highlight_cursor: nil, max_steps: nil)
         #   @param instruction [String] Natural language instruction for the agent
         #
         #   @param highlight_cursor [Boolean] Whether to visually highlight the cursor during execution
         #
         #   @param max_steps [Float] Maximum number of steps the agent can take
-        #
-        #   @param tool_timeout [Float] Timeout in milliseconds for each agent tool call
-        #
-        #   @param use_search [Boolean] Whether to enable the web search tool powered by Browserbase Search API
       end
 
       # Whether to stream the response via SSE