context.dev 1.31.0 → 1.34.0

data/rbi/context_dev/models/web_extract_fonts_response.rbi

@@ -55,6 +55,23 @@ module ContextDev
       end
       attr_writer :font_links
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::WebExtractFontsResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebExtractFontsResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           code: Integer,
@@ -66,7 +83,9 @@ module ContextDev
             T::Hash[
               Symbol,
               ContextDev::Models::WebExtractFontsResponse::FontLink::OrHash
-            ]
+            ],
+          key_metadata:
+            ContextDev::Models::WebExtractFontsResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -81,7 +100,10 @@ module ContextDev
         # Font assets keyed by family name as it appears in the fonts array (non-generic
         # names only). Clients match entries in fonts to pick a file URL from files.
         # Omitted when no families resolve to Google or custom @font-face URLs.
-        font_links: nil
+        font_links: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -96,7 +118,9 @@ module ContextDev
               T::Hash[
                 Symbol,
                 ContextDev::Models::WebExtractFontsResponse::FontLink
-              ]
+              ],
+            key_metadata:
+              ContextDev::Models::WebExtractFontsResponse::KeyMetadata
           }
         )
       end
@@ -296,6 +320,47 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractFontsResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_params.rbi

@@ -64,6 +64,21 @@ module ContextDev
       sig { params(max_age_ms: Integer).void }
       attr_writer :max_age_ms
 
+      # Optional maximum link depth from the starting URL (0 = only the starting page).
+      # If omitted, there is no crawl depth limit.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_depth
+
+      sig { params(max_depth: Integer).void }
+      attr_writer :max_depth
+
+      # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_pages
+
+      sig { params(max_pages: Integer).void }
+      attr_writer :max_pages
+
       sig { returns(T.nilable(ContextDev::WebExtractParams::Pdf)) }
       attr_reader :pdf
 
@@ -104,6 +119,8 @@ module ContextDev
           include_frames: T::Boolean,
           instructions: String,
           max_age_ms: Integer,
+          max_depth: Integer,
+          max_pages: Integer,
           pdf: ContextDev::WebExtractParams::Pdf::OrHash,
           stop_after_ms: Integer,
           timeout_ms: Integer,
@@ -136,6 +153,11 @@ module ContextDev
         # Return cached scrape results if a prior scrape for the same parameters is
         # younger than this many milliseconds. Defaults to 7 days (604800000 ms).
         max_age_ms: nil,
+        # Optional maximum link depth from the starting URL (0 = only the starting page).
+        # If omitted, there is no crawl depth limit.
+        max_depth: nil,
+        # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+        max_pages: nil,
         pdf: nil,
         # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000
         # (110s). Default: 80000 (80s).
@@ -161,6 +183,8 @@ module ContextDev
             include_frames: T::Boolean,
             instructions: String,
             max_age_ms: Integer,
+            max_depth: Integer,
+            max_pages: Integer,
             pdf: ContextDev::WebExtractParams::Pdf,
             stop_after_ms: Integer,
             timeout_ms: Integer,

data/rbi/context_dev/models/web_extract_response.rbi

@@ -37,13 +37,30 @@ module ContextDev
       sig { returns(T::Array[String]) }
       attr_accessor :urls_analyzed
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(T.nilable(ContextDev::Models::WebExtractResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           data: T::Hash[Symbol, T.anything],
           metadata: ContextDev::Models::WebExtractResponse::Metadata::OrHash,
           status: String,
           url: String,
-          urls_analyzed: T::Array[String]
+          urls_analyzed: T::Array[String],
+          key_metadata:
+            ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -55,7 +72,10 @@ module ContextDev
         # The starting URL that was analyzed
         url:,
         # List of URLs whose Markdown was used for extraction
-        urls_analyzed:
+        urls_analyzed:,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -66,7 +86,8 @@ module ContextDev
             metadata: ContextDev::Models::WebExtractResponse::Metadata,
             status: String,
             url: String,
-            urls_analyzed: T::Array[String]
+            urls_analyzed: T::Array[String],
+            key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata
           }
         )
       end
@@ -129,6 +150,47 @@ module ContextDev
         def to_hash
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_styleguide_response.rbi

@@ -25,6 +25,25 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -54,6 +73,8 @@ module ContextDev
         params(
           code: Integer,
           domain: String,
+          key_metadata:
+            ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata::OrHash,
           status: String,
           styleguide:
             ContextDev::Models::WebExtractStyleguideResponse::Styleguide::OrHash
@@ -64,6 +85,9 @@ module ContextDev
         code: nil,
         # The normalized domain that was processed
         domain: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil,
         # Status of the response, e.g., 'ok'
         status: nil,
         # Comprehensive styleguide data extracted from the website
@@ -76,6 +100,8 @@ module ContextDev
           {
             code: Integer,
             domain: String,
+            key_metadata:
+              ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata,
             status: String,
             styleguide:
               ContextDev::Models::WebExtractStyleguideResponse::Styleguide
@@ -85,6 +111,47 @@ module ContextDev
       def to_hash
       end
 
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class Styleguide < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/context_dev/models/web_screenshot_response.rbi

@@ -32,6 +32,23 @@ module ContextDev
       sig { params(height: Integer).void }
       attr_writer :height
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::WebScreenshotResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebScreenshotResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Public URL of the uploaded screenshot image
       sig { returns(T.nilable(String)) }
       attr_reader :screenshot
@@ -76,6 +93,8 @@ module ContextDev
           code: Integer,
           domain: String,
           height: Integer,
+          key_metadata:
+            ContextDev::Models::WebScreenshotResponse::KeyMetadata::OrHash,
           screenshot: String,
           screenshot_type:
             ContextDev::Models::WebScreenshotResponse::ScreenshotType::OrSymbol,
@@ -90,6 +109,9 @@ module ContextDev
         domain: nil,
         # Height in pixels of the returned screenshot image
         height: nil,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil,
         # Public URL of the uploaded screenshot image
         screenshot: nil,
         # Type of screenshot that was captured
@@ -107,6 +129,8 @@ module ContextDev
             code: Integer,
             domain: String,
             height: Integer,
+            key_metadata:
+              ContextDev::Models::WebScreenshotResponse::KeyMetadata,
             screenshot: String,
             screenshot_type:
               ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol,
@@ -118,6 +142,47 @@ module ContextDev
       def to_hash
       end
 
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebScreenshotResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+
       # Type of screenshot that was captured
       module ScreenshotType
         extend ContextDev::Internal::Type::Enum

data/rbi/context_dev/models/web_search_response.rbi

@@ -18,17 +18,37 @@ module ContextDev
       sig { returns(T::Array[ContextDev::Models::WebSearchResponse::Result]) }
       attr_accessor :results
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(T.nilable(ContextDev::Models::WebSearchResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           query: String,
           results:
-            T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash]
+            T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash],
+          key_metadata:
+            ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # Echo of the original query (useful when fanout was enabled).
         query:,
-        results:
+        results:,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -36,7 +56,8 @@ module ContextDev
         override.returns(
           {
             query: String,
-            results: T::Array[ContextDev::Models::WebSearchResponse::Result]
+            results: T::Array[ContextDev::Models::WebSearchResponse::Result],
+            key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata
           }
         )
       end
@@ -266,6 +287,47 @@ module ContextDev
           end
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebSearchResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end