stagehand 3.7.0 → 3.18.0

data/sig/stagehand/internal/util.rbs

@@ -106,6 +106,16 @@ module Stagehand
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/stagehand/models/model_config.rbs

@@ -5,6 +5,7 @@ module Stagehand
         model_name: String,
         api_key: String,
         base_url: String,
+        headers: ::Hash[Symbol, String],
         provider: Stagehand::Models::ModelConfig::provider
       }
 
@@ -19,6 +20,10 @@ module Stagehand
 
       def base_url=: (String) -> String
 
+      attr_reader headers: ::Hash[Symbol, String]?
+
+      def headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
       attr_reader provider: Stagehand::Models::ModelConfig::provider?
 
       def provider=: (
@@ -29,6 +34,7 @@ module Stagehand
         model_name: String,
         ?api_key: String,
         ?base_url: String,
+        ?headers: ::Hash[Symbol, String],
         ?provider: Stagehand::Models::ModelConfig::provider
       ) -> void
 
@@ -36,6 +42,7 @@ module Stagehand
         model_name: String,
         api_key: String,
         base_url: String,
+        headers: ::Hash[Symbol, String],
         provider: Stagehand::Models::ModelConfig::provider
       }
 

data/sig/stagehand/models/session_act_params.rbs

@@ -2,6 +2,7 @@ module Stagehand
   module Models
     type session_act_params =
       {
+        id: String,
         input: Stagehand::Models::SessionActParams::input,
         frame_id: String?,
         options: Stagehand::SessionActParams::Options,
@@ -13,6 +14,8 @@ module Stagehand
       extend Stagehand::Internal::Type::RequestParameters::Converter
       include Stagehand::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor input: Stagehand::Models::SessionActParams::input
 
       attr_accessor frame_id: String?
@@ -30,6 +33,7 @@ module Stagehand
       ) -> Stagehand::Models::SessionActParams::x_stream_response
 
       def initialize: (
+        id: String,
         input: Stagehand::Models::SessionActParams::input,
         ?frame_id: String?,
         ?options: Stagehand::SessionActParams::Options,
@@ -38,6 +42,7 @@ module Stagehand
       ) -> void
 
       def to_hash: -> {
+        id: String,
         input: Stagehand::Models::SessionActParams::input,
         frame_id: String?,
         options: Stagehand::SessionActParams::Options,
@@ -57,7 +62,7 @@ module Stagehand
         {
           model: Stagehand::Models::SessionActParams::Options::model,
           timeout: Float,
-          variables: ::Hash[Symbol, String]
+          variables: ::Hash[Symbol, Stagehand::Models::SessionActParams::Options::variable]
         }
 
       class Options < Stagehand::Internal::Type::BaseModel
@@ -71,20 +76,22 @@ module Stagehand
 
         def timeout=: (Float) -> Float
 
-        attr_reader variables: ::Hash[Symbol, String]?
+        attr_reader variables: ::Hash[Symbol, Stagehand::Models::SessionActParams::Options::variable]?
 
-        def variables=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+        def variables=: (
+          ::Hash[Symbol, Stagehand::Models::SessionActParams::Options::variable]
+        ) -> ::Hash[Symbol, Stagehand::Models::SessionActParams::Options::variable]
 
         def initialize: (
           ?model: Stagehand::Models::SessionActParams::Options::model,
           ?timeout: Float,
-          ?variables: ::Hash[Symbol, String]
+          ?variables: ::Hash[Symbol, Stagehand::Models::SessionActParams::Options::variable]
         ) -> void
 
         def to_hash: -> {
           model: Stagehand::Models::SessionActParams::Options::model,
           timeout: Float,
-          variables: ::Hash[Symbol, String]
+          variables: ::Hash[Symbol, Stagehand::Models::SessionActParams::Options::variable]
         }
 
         type model = Stagehand::ModelConfig | String
@@ -94,6 +101,50 @@ module Stagehand
 
           def self?.variants: -> ::Array[Stagehand::Models::SessionActParams::Options::model]
         end
+
+        type variable =
+          String
+          | Float
+          | bool
+          | Stagehand::SessionActParams::Options::Variable::UnionMember3
+
+        module Variable
+          extend Stagehand::Internal::Type::Union
+
+          type union_member3 =
+            {
+              value: Stagehand::Models::SessionActParams::Options::Variable::UnionMember3::value,
+              description: String
+            }
+
+          class UnionMember3 < Stagehand::Internal::Type::BaseModel
+            attr_accessor value: Stagehand::Models::SessionActParams::Options::Variable::UnionMember3::value
+
+            attr_reader description: String?
+
+            def description=: (String) -> String
+
+            def initialize: (
+              value: Stagehand::Models::SessionActParams::Options::Variable::UnionMember3::value,
+              ?description: String
+            ) -> void
+
+            def to_hash: -> {
+              value: Stagehand::Models::SessionActParams::Options::Variable::UnionMember3::value,
+              description: String
+            }
+
+            type value = String | Float | bool
+
+            module Value
+              extend Stagehand::Internal::Type::Union
+
+              def self?.variants: -> ::Array[Stagehand::Models::SessionActParams::Options::Variable::UnionMember3::value]
+            end
+          end
+
+          def self?.variants: -> ::Array[Stagehand::Models::SessionActParams::Options::variable]
+        end
       end
 
       type x_stream_response = :true | :false

data/sig/stagehand/models/session_end_params.rbs

@@ -2,6 +2,7 @@ module Stagehand
   module Models
     type session_end_params =
       {
+        id: String,
         x_stream_response: Stagehand::Models::SessionEndParams::x_stream_response
       }
       & Stagehand::Internal::Type::request_parameters
@@ -10,6 +11,8 @@ module Stagehand
       extend Stagehand::Internal::Type::RequestParameters::Converter
       include Stagehand::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_reader x_stream_response: Stagehand::Models::SessionEndParams::x_stream_response?
 
       def x_stream_response=: (
@@ -17,11 +20,13 @@ module Stagehand
       ) -> Stagehand::Models::SessionEndParams::x_stream_response
 
       def initialize: (
+        id: String,
         ?x_stream_response: Stagehand::Models::SessionEndParams::x_stream_response,
         ?request_options: Stagehand::request_opts
       ) -> void
 
       def to_hash: -> {
+        id: String,
         x_stream_response: Stagehand::Models::SessionEndParams::x_stream_response,
         request_options: Stagehand::RequestOptions
       }

data/sig/stagehand/models/session_execute_params.rbs

@@ -2,6 +2,7 @@ module Stagehand
   module Models
     type session_execute_params =
       {
+        id: String,
         agent_config: Stagehand::SessionExecuteParams::AgentConfig,
         execute_options: Stagehand::SessionExecuteParams::ExecuteOptions,
         frame_id: String?,
@@ -14,6 +15,8 @@ module Stagehand
       extend Stagehand::Internal::Type::RequestParameters::Converter
       include Stagehand::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor agent_config: Stagehand::SessionExecuteParams::AgentConfig
 
       attr_accessor execute_options: Stagehand::SessionExecuteParams::ExecuteOptions
@@ -31,6 +34,7 @@ module Stagehand
       ) -> Stagehand::Models::SessionExecuteParams::x_stream_response
 
       def initialize: (
+        id: String,
         agent_config: Stagehand::SessionExecuteParams::AgentConfig,
         execute_options: Stagehand::SessionExecuteParams::ExecuteOptions,
         ?frame_id: String?,
@@ -40,6 +44,7 @@ module Stagehand
       ) -> void
 
       def to_hash: -> {
+        id: String,
         agent_config: Stagehand::SessionExecuteParams::AgentConfig,
         execute_options: Stagehand::SessionExecuteParams::ExecuteOptions,
         frame_id: String?,
@@ -153,7 +158,13 @@ module Stagehand
       end
 
       type execute_options =
-        { instruction: String, highlight_cursor: bool, max_steps: Float }
+        {
+          instruction: String,
+          highlight_cursor: bool,
+          max_steps: Float,
+          tool_timeout: Float,
+          use_search: bool
+        }
 
       class ExecuteOptions < Stagehand::Internal::Type::BaseModel
         attr_accessor instruction: String
@@ -166,16 +177,28 @@ module Stagehand
 
         def max_steps=: (Float) -> Float
 
+        attr_reader tool_timeout: Float?
+
+        def tool_timeout=: (Float) -> Float
+
+        attr_reader use_search: bool?
+
+        def use_search=: (bool) -> bool
+
         def initialize: (
           instruction: String,
           ?highlight_cursor: bool,
-          ?max_steps: Float
+          ?max_steps: Float,
+          ?tool_timeout: Float,
+          ?use_search: bool
         ) -> void
 
         def to_hash: -> {
           instruction: String,
           highlight_cursor: bool,
-          max_steps: Float
+          max_steps: Float,
+          tool_timeout: Float,
+          use_search: bool
         }
       end
 

data/sig/stagehand/models/session_extract_params.rbs

@@ -2,6 +2,7 @@ module Stagehand
   module Models
     type session_extract_params =
       {
+        id: String,
         frame_id: String?,
         instruction: String,
         options: Stagehand::SessionExtractParams::Options,
@@ -14,6 +15,8 @@ module Stagehand
       extend Stagehand::Internal::Type::RequestParameters::Converter
       include Stagehand::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor frame_id: String?
 
       attr_reader instruction: String?
@@ -37,6 +40,7 @@ module Stagehand
       ) -> Stagehand::Models::SessionExtractParams::x_stream_response
 
       def initialize: (
+        id: String,
         ?frame_id: String?,
         ?instruction: String,
         ?options: Stagehand::SessionExtractParams::Options,
@@ -46,6 +50,7 @@ module Stagehand
       ) -> void
 
       def to_hash: -> {
+        id: String,
         frame_id: String?,
         instruction: String,
         options: Stagehand::SessionExtractParams::Options,

data/sig/stagehand/models/session_navigate_params.rbs

@@ -2,6 +2,7 @@ module Stagehand
   module Models
     type session_navigate_params =
       {
+        id: String,
         url: String,
         frame_id: String?,
         options: Stagehand::SessionNavigateParams::Options,
@@ -14,6 +15,8 @@ module Stagehand
       extend Stagehand::Internal::Type::RequestParameters::Converter
       include Stagehand::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor url: String
 
       attr_accessor frame_id: String?
@@ -35,6 +38,7 @@ module Stagehand
       ) -> Stagehand::Models::SessionNavigateParams::x_stream_response
 
       def initialize: (
+        id: String,
         url: String,
         ?frame_id: String?,
         ?options: Stagehand::SessionNavigateParams::Options,
@@ -44,6 +48,7 @@ module Stagehand
       ) -> void
 
       def to_hash: -> {
+        id: String,
         url: String,
         frame_id: String?,
         options: Stagehand::SessionNavigateParams::Options,

data/sig/stagehand/models/session_observe_params.rbs

@@ -2,6 +2,7 @@ module Stagehand
   module Models
     type session_observe_params =
       {
+        id: String,
         frame_id: String?,
         instruction: String,
         options: Stagehand::SessionObserveParams::Options,
@@ -13,6 +14,8 @@ module Stagehand
       extend Stagehand::Internal::Type::RequestParameters::Converter
       include Stagehand::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor frame_id: String?
 
       attr_reader instruction: String?
@@ -32,6 +35,7 @@ module Stagehand
       ) -> Stagehand::Models::SessionObserveParams::x_stream_response
 
       def initialize: (
+        id: String,
         ?frame_id: String?,
         ?instruction: String,
         ?options: Stagehand::SessionObserveParams::Options,
@@ -40,6 +44,7 @@ module Stagehand
       ) -> void
 
       def to_hash: -> {
+        id: String,
         frame_id: String?,
         instruction: String,
         options: Stagehand::SessionObserveParams::Options,
@@ -51,7 +56,8 @@ module Stagehand
         {
           model: Stagehand::Models::SessionObserveParams::Options::model,
           selector: String,
-          timeout: Float
+          timeout: Float,
+          variables: ::Hash[Symbol, Stagehand::Models::SessionObserveParams::Options::variable]
         }
 
       class Options < Stagehand::Internal::Type::BaseModel
@@ -69,16 +75,24 @@ module Stagehand
 
         def timeout=: (Float) -> Float
 
+        attr_reader variables: ::Hash[Symbol, Stagehand::Models::SessionObserveParams::Options::variable]?
+
+        def variables=: (
+          ::Hash[Symbol, Stagehand::Models::SessionObserveParams::Options::variable]
+        ) -> ::Hash[Symbol, Stagehand::Models::SessionObserveParams::Options::variable]
+
         def initialize: (
           ?model: Stagehand::Models::SessionObserveParams::Options::model,
           ?selector: String,
-          ?timeout: Float
+          ?timeout: Float,
+          ?variables: ::Hash[Symbol, Stagehand::Models::SessionObserveParams::Options::variable]
         ) -> void
 
         def to_hash: -> {
           model: Stagehand::Models::SessionObserveParams::Options::model,
           selector: String,
-          timeout: Float
+          timeout: Float,
+          variables: ::Hash[Symbol, Stagehand::Models::SessionObserveParams::Options::variable]
         }
 
         type model = Stagehand::ModelConfig | String
@@ -88,6 +102,50 @@ module Stagehand
 
           def self?.variants: -> ::Array[Stagehand::Models::SessionObserveParams::Options::model]
         end
+
+        type variable =
+          String
+          | Float
+          | bool
+          | Stagehand::SessionObserveParams::Options::Variable::UnionMember3
+
+        module Variable
+          extend Stagehand::Internal::Type::Union
+
+          type union_member3 =
+            {
+              value: Stagehand::Models::SessionObserveParams::Options::Variable::UnionMember3::value,
+              description: String
+            }
+
+          class UnionMember3 < Stagehand::Internal::Type::BaseModel
+            attr_accessor value: Stagehand::Models::SessionObserveParams::Options::Variable::UnionMember3::value
+
+            attr_reader description: String?
+
+            def description=: (String) -> String
+
+            def initialize: (
+              value: Stagehand::Models::SessionObserveParams::Options::Variable::UnionMember3::value,
+              ?description: String
+            ) -> void
+
+            def to_hash: -> {
+              value: Stagehand::Models::SessionObserveParams::Options::Variable::UnionMember3::value,
+              description: String
+            }
+
+            type value = String | Float | bool
+
+            module Value
+              extend Stagehand::Internal::Type::Union
+
+              def self?.variants: -> ::Array[Stagehand::Models::SessionObserveParams::Options::Variable::UnionMember3::value]
+            end
+          end
+
+          def self?.variants: -> ::Array[Stagehand::Models::SessionObserveParams::Options::variable]
+        end
       end
 
       type x_stream_response = :true | :false

data/sig/stagehand/models/session_replay_params.rbs

@@ -2,6 +2,7 @@ module Stagehand
   module Models
     type session_replay_params =
       {
+        id: String,
         x_stream_response: Stagehand::Models::SessionReplayParams::x_stream_response
       }
       & Stagehand::Internal::Type::request_parameters
@@ -10,6 +11,8 @@ module Stagehand
       extend Stagehand::Internal::Type::RequestParameters::Converter
       include Stagehand::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_reader x_stream_response: Stagehand::Models::SessionReplayParams::x_stream_response?
 
       def x_stream_response=: (
@@ -17,11 +20,13 @@ module Stagehand
       ) -> Stagehand::Models::SessionReplayParams::x_stream_response
 
       def initialize: (
+        id: String,
         ?x_stream_response: Stagehand::Models::SessionReplayParams::x_stream_response,
         ?request_options: Stagehand::request_opts
       ) -> void
 
       def to_hash: -> {
+        id: String,
         x_stream_response: Stagehand::Models::SessionReplayParams::x_stream_response,
         request_options: Stagehand::RequestOptions
       }

data/sig/stagehand/models/session_start_params.rbs

@@ -147,6 +147,7 @@ module Stagehand
           {
             accept_downloads: bool,
             args: ::Array[String],
+            cdp_headers: ::Hash[Symbol, String],
             cdp_url: String,
             chromium_sandbox: bool,
             connect_timeout_ms: Float,
@@ -175,6 +176,10 @@ module Stagehand
 
           def args=: (::Array[String]) -> ::Array[String]
 
+          attr_reader cdp_headers: ::Hash[Symbol, String]?
+
+          def cdp_headers=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
           attr_reader cdp_url: String?
 
           def cdp_url=: (String) -> String
@@ -252,6 +257,7 @@ module Stagehand
           def initialize: (
             ?accept_downloads: bool,
             ?args: ::Array[String],
+            ?cdp_headers: ::Hash[Symbol, String],
             ?cdp_url: String,
             ?chromium_sandbox: bool,
             ?connect_timeout_ms: Float,
@@ -274,6 +280,7 @@ module Stagehand
           def to_hash: -> {
             accept_downloads: bool,
             args: ::Array[String],
+            cdp_headers: ::Hash[Symbol, String],
             cdp_url: String,
             chromium_sandbox: bool,
             connect_timeout_ms: Float,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stagehand
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.18.0
 platform: ruby
 authors:
 - Stagehand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-25 00:00:00.000000000 Z
+date: 2026-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi