context.dev 2.16.0 → 2.17.1

data/lib/context_dev/resources/brand.rb

@@ -36,7 +36,7 @@ module ContextDev
       # information: domain, title, colors, logos, and backdrops. Optimized for faster
       # responses and reduced data transfer.
       #
-      # @overload retrieve_simplified(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_simplified(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_opts: nil, request_options: {})
       #
       # @param domain [String] Domain name to retrieve simplified brand data for
       #
@@ -46,7 +46,7 @@ module ContextDev
       #
       # @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -59,7 +59,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "brand/retrieve-simplified",
-          query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_opts: "timeoutOpts"),
           model: ContextDev::Models::BrandRetrieveSimplifiedResponse,
           options: options
         )

data/lib/context_dev/resources/industry.rb

@@ -8,7 +8,7 @@ module ContextDev
       #
       # Classify any brand into 2022 NAICS industry codes from its domain or name.
       #
-      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload retrieve_naics(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided,
       #
@@ -18,7 +18,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -34,7 +34,7 @@ module ContextDev
           query: query.transform_keys(
             max_results: "maxResults",
             min_results: "minResults",
-            timeout_ms: "timeoutMS"
+            timeout_opts: "timeoutOpts"
           ),
           model: ContextDev::Models::IndustryRetrieveNaicsResponse,
           options: options
@@ -48,7 +48,7 @@ module ContextDev
       # domain or name. Choose between the original SIC system (`original_sic`) or the
       # latest SIC list maintained by the SEC (`latest_sec`).
       #
-      # @overload retrieve_sic(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, type: nil, request_options: {})
+      # @overload retrieve_sic(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, request_options: {})
       #
       # @param input [String] Brand domain or title to retrieve SIC code for. If a valid domain is provided, i
       #
@@ -58,7 +58,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
       #
@@ -76,7 +76,7 @@ module ContextDev
           query: query.transform_keys(
             max_results: "maxResults",
             min_results: "minResults",
-            timeout_ms: "timeoutMS"
+            timeout_opts: "timeoutOpts"
           ),
           model: ContextDev::Models::IndustryRetrieveSicResponse,
           options: options

data/lib/context_dev/resources/people.rb

@@ -11,7 +11,7 @@ module ContextDev
       # plans. Successful requests cost 20 credits. Disposable and free email addresses
       # (like gmail.com, yahoo.com) will throw a 422 error.
       #
-      # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param company [ContextDev::Models::PersonEnrichParams::Company]
       #
@@ -27,7 +27,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/context_dev/resources/utility.rb

@@ -12,7 +12,7 @@ module ContextDev
       # or an email whose domain is extracted and validated (free email providers and
       # disposable email addresses are not allowed).
       #
-      # @overload prefetch(identifier:, type:, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload prefetch(identifier:, type:, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param identifier [ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier] Identifier of the target to prefetch. Provide exactly one of domain or email.
       #
@@ -20,7 +20,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::UtilityPrefetchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/context_dev/resources/web.rb

@@ -3,13 +3,50 @@
 module ContextDev
   module Resources
     class Web
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::WebAnswersParams} for more details.
+      #
+      # Researches the live web and returns a sourced answer in your requested JSON
+      # shape. Select fast for a smaller research budget at 10 credits or ultra for
+      # deeper reasoning at 100 credits. Defaults to ultra. Fast research is limited to
+      # 30 seconds and ultra to 50 seconds; timeoutOpts.milliseconds can shorten either
+      # deadline.
+      #
+      # @overload answers(task:, json_format: nil, mode: nil, tags: nil, timeout_opts: nil, request_options: {})
+      #
+      # @param task [String] What to research and answer, in plain language. Naming a domain in the task (for
+      #
+      # @param json_format [Hash{Symbol=>Object}] An example object with placeholder values (for example {"pricing_page_url": "",
+      #
+      # @param mode [Symbol, ContextDev::Models::WebAnswersParams::Mode] Research level: fast uses a smaller model and research budget for 10 credits; ul
+      #
+      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      # @param timeout_opts [ContextDev::Models::WebAnswersParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::WebAnswersResponse]
+      #
+      # @see ContextDev::Models::WebAnswersParams
+      def answers(params)
+        parsed, options = ContextDev::WebAnswersParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "web/answers",
+          body: parsed,
+          model: ContextDev::Models::WebAnswersResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebExtractParams} for more details.
       #
       # Crawl a website, use the provided JSON Schema and instructions to prioritize
       # relevant internal links, and extract structured data from the selected pages.
       #
-      # @overload extract(schema:, url:, actions: nil, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, stop_after_ms: nil, tags: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
+      # @overload extract(schema:, url:, actions: nil, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, stop_after_ms: nil, tags: nil, timeout_opts: nil, wait_for_ms: nil, request_options: {})
       #
       # @param schema [Hash{Symbol=>Object}] JSON Schema for the returned data object. Image fields such as `image_urls` or `
       #
@@ -39,7 +76,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebExtractParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load for each craw
       #
@@ -65,7 +102,7 @@ module ContextDev
       # Analyze a company's landing page and web search evidence to return direct
       # competitors for the same product or market.
       #
-      # @overload extract_competitors(domain:, num_competitors: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload extract_competitors(domain:, num_competitors: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param domain [String] Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted
       #
@@ -73,7 +110,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -86,7 +123,7 @@ module ContextDev
         @client.request(
           method: :get,
           path: "web/competitors",
-          query: query.transform_keys(num_competitors: "numCompetitors", timeout_ms: "timeoutMS"),
+          query: query.transform_keys(num_competitors: "numCompetitors", timeout_opts: "timeoutOpts"),
           model: ContextDev::Models::WebExtractCompetitorsResponse,
           options: options
         )
@@ -98,7 +135,7 @@ module ContextDev
       # Scrape font information from a website including font families, usage
       # statistics, fallbacks, and element/word counts.
       #
-      # @overload extract_fonts(direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload extract_fonts(direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param direct_url [String] A specific URL to fetch fonts from directly, bypassing domain resolution (e.g.,
       #
@@ -108,7 +145,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebExtractFontsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -124,7 +161,7 @@ module ContextDev
           query: query.transform_keys(
             direct_url: "directUrl",
             max_age_ms: "maxAgeMs",
-            timeout_ms: "timeoutMS"
+            timeout_opts: "timeoutOpts"
           ),
           model: ContextDev::Models::WebExtractFontsResponse,
           options: options
@@ -137,7 +174,7 @@ module ContextDev
       # Extract a comprehensive design system from a website including colors,
       # typography, spacing, shadows, and UI components.
       #
-      # @overload extract_styleguide(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload extract_styleguide(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param color_scheme [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme] Optional browser color scheme to emulate for websites that respond to prefers-co
       #
@@ -149,7 +186,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -166,7 +203,7 @@ module ContextDev
             color_scheme: "colorScheme",
             direct_url: "directUrl",
             max_age_ms: "maxAgeMs",
-            timeout_ms: "timeoutMS"
+            timeout_opts: "timeoutOpts"
           ),
           model: ContextDev::Models::WebExtractStyleguideResponse,
           options: options
@@ -178,7 +215,7 @@ module ContextDev
       #
       # Capture a screenshot of a website.
       #
-      # @overload screenshot(clear_popups: nil, color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, tags: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @overload screenshot(clear_popups: nil, color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, tags: nil, timeout_opts: nil, viewport: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #
       # @param clear_popups [Boolean] Optional parameter for comprehensive popup cleanup. If 'true', the browser dismi
       #
@@ -202,7 +239,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebScreenshotParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param viewport [ContextDev::Models::WebScreenshotParams::Viewport] Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
       #
@@ -229,7 +266,7 @@ module ContextDev
             handle_cookie_popup: "handleCookiePopup",
             max_age_ms: "maxAgeMs",
             scroll_offset: "scrollOffset",
-            timeout_ms: "timeoutMS",
+            timeout_opts: "timeoutOpts",
             wait_for_ms: "waitForMs"
           ),
           model: ContextDev::Models::WebScreenshotResponse,
@@ -242,7 +279,7 @@ module ContextDev
       #
       # Search the web and optionally scrape each result to Markdown in one round-trip.
       #
-      # @overload search(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @overload search(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_opts: nil, request_options: {})
       #
       # @param query [String] Search query. Accepts natural language as well as Google-style search operators
       #
@@ -262,7 +299,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -286,7 +323,7 @@ module ContextDev
       # Performs a crawl starting from a given URL, extracts page content as Markdown,
       # and returns results for all crawled pages.
       #
-      # @overload web_crawl_md(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, tags: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @overload web_crawl_md(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, tags: nil, timeout_opts: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #
       # @param url [String] The starting URL for the crawl (must include http:// or https:// protocol)
       #
@@ -320,7 +357,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param url_regex [String] Regex pattern. Only URLs matching this pattern will be followed and scraped. An
       #
@@ -346,13 +383,62 @@ module ContextDev
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::WebWebScrapeBytesParams} for more details.
+      #
+      # Downloads a resource and returns its bytes as base64. Supports images, PDFs,
+      # HTML pages, and any other content type without image conversion, text
+      # extraction, or character-encoding changes. HTTP compression is decoded before
+      # base64 encoding. HTML is the original HTTP response; JavaScript is not rendered.
+      # Follows public redirects and retries failed downloads through ISP and
+      # residential proxies, with a direct fallback. When country is specified, only a
+      # residential proxy in that country is used. Supply headers such as Referer for
+      # images that require a referring page. Downloads are not cached. Maximum decoded
+      # resource size: 20 MiB (20971520 bytes), before base64 encoding. Successful
+      # requests cost 1 credit; errors are not billed.
+      #
+      # @overload web_scrape_bytes(url:, country: nil, headers: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
+      #
+      # @param url [String] Full HTTP(S) URL of the resource to download, such as an image, PDF, or page.
+      #
+      # @param country [Symbol, ContextDev::Models::WebWebScrapeBytesParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
+      #
+      # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers, such as Referer, Cookie, or Authorization. Send
+      #
+      # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      #
+      # @param timeout_opts [ContextDev::Models::WebWebScrapeBytesParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #
+      # @param zdr [Symbol, ContextDev::Models::WebWebScrapeBytesParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::WebWebScrapeBytesResponse]
+      #
+      # @see ContextDev::Models::WebWebScrapeBytesParams
+      def web_scrape_bytes(params)
+        parsed, options = ContextDev::WebWebScrapeBytesParams.dump_request(params)
+        query = ContextDev::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "web/scrape/bytes",
+          query: query.transform_keys(timeout_opts: "timeoutOpts"),
+          model: ContextDev::Models::WebWebScrapeBytesResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
       #
       # Scrapes the given URL and returns the raw HTML content of the page. The base
-      # request costs 1 credit; requests with browser actions cost 2 credits.
+      # request costs 1 credit; requests with browser actions cost 2 credits. A request
+      # that hits its timeoutOpts.milliseconds deadline fails with 408 and is not
+      # billed, unless timeoutOpts.behavior=return-partial is set — then the page as
+      # rendered so far is returned with `finalDOMState: "still-loading"` and billed at
+      # the base cost of 1 credit.
       #
-      # @overload web_scrape_html(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, tags: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @overload web_scrape_html(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, tags: nil, timeout_opts: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #
       # @param url [String] Full URL to scrape (must include http:// or https:// protocol)
       #
@@ -376,7 +462,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h
       #
@@ -401,7 +487,7 @@ module ContextDev
             include_selectors: "includeSelectors",
             max_age_ms: "maxAgeMs",
             settle_animations: "settleAnimations",
-            timeout_ms: "timeoutMS",
+            timeout_opts: "timeoutOpts",
             use_main_content_only: "useMainContentOnly",
             wait_for_ms: "waitForMs"
           ),
@@ -419,7 +505,7 @@ module ContextDev
       # enrichment is enabled, the entire call costs 5 credits, including requests that
       # also use actions.
       #
-      # @overload web_scrape_images(url:, actions: nil, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, tags: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
+      # @overload web_scrape_images(url:, actions: nil, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, wait_for_ms: nil, request_options: {})
       #
       # @param url [String] Page URL to inspect. Must include http:// or https://.
       #
@@ -435,7 +521,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load before collec
       #
@@ -452,7 +538,7 @@ module ContextDev
           path: "web/scrape/images",
           query: query.transform_keys(
             max_age_ms: "maxAgeMs",
-            timeout_ms: "timeoutMS",
+            timeout_opts: "timeoutOpts",
             wait_for_ms: "waitForMs"
           ),
           model: ContextDev::Models::WebWebScrapeImagesResponse,
@@ -483,17 +569,17 @@ module ContextDev
       #
       # | HTTP status | Billed?                                   | Meaning                                                                                                                                                                                                                                                                                                       |
       # | ----------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-      # | 200         | Yes — 1 credit, or 2 credits with actions | Successful scrape, including a zero-length result when includeSelectors matched nothing                                                                                                                                                                                                                       |
+      # | 200         | Yes — 1 credit, or 2 credits with actions | Successful scrape, including a zero-length result when includeSelectors matched nothing. A partial result (`finalDOMState: "still-loading"`, only with timeoutOpts.behavior=return-partial) is billed at the base 1 credit with no OCR or actions surcharge                                                   |
       # | 400         | No                                        | Invalid input, skipped PDF, or the page could not be scraped. error_code WEBSITE_BLOCKED specifically means the site answered with an anti-bot challenge, CAPTCHA wall, or login shell instead of the page (even when the site returned HTTP 200) — retrying later or from another country sometimes succeeds |
       # | 401 / 403   | No                                        | Invalid/disabled key, insufficient permissions, or credits exhausted; inspect error_code                                                                                                                                                                                                                      |
       # | 404         | No                                        | Target page returned or fingerprinted as not found                                                                                                                                                                                                                                                            |
-      # | 408         | No                                        | Request timed out                                                                                                                                                                                                                                                                                             |
+      # | 408         | No                                        | Request timed out. With timeoutOpts.behavior=return-partial this only happens when nothing usable had rendered by the deadline                                                                                                                                                                                |
       # | 413         | No                                        | Target content exceeds the maximum supported size (20 MB)                                                                                                                                                                                                                                                     |
       # | 415         | No                                        | Unsupported content type                                                                                                                                                                                                                                                                                      |
       # | 429         | No                                        | Per-minute rate limit exceeded; honor Retry-After                                                                                                                                                                                                                                                             |
       # | 500         | No                                        | Internal error                                                                                                                                                                                                                                                                                                |
       #
-      # @overload web_scrape_md(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_html: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, tags: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @overload web_scrape_md(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_html: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, tags: nil, timeout_opts: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #
       # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr
       #
@@ -525,7 +611,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars,
       #
@@ -554,7 +640,7 @@ module ContextDev
             max_age_ms: "maxAgeMs",
             settle_animations: "settleAnimations",
             shorten_base64_images: "shortenBase64Images",
-            timeout_ms: "timeoutMS",
+            timeout_opts: "timeoutOpts",
             use_main_content_only: "useMainContentOnly",
             wait_for_ms: "waitForMs"
           ),
@@ -573,7 +659,7 @@ module ContextDev
       # `pricing and plans` or `api authentication docs`), most relevant first — a
       # searched crawl scans the whole sitemap and costs 2 credits instead of 1.
       #
-      # @overload web_scrape_sitemap(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
+      # @overload web_scrape_sitemap(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_opts: nil, url_regex: nil, zdr: nil, request_options: {})
       #
       # @param domain [String] Domain to build a sitemap for
       #
@@ -589,7 +675,7 @@ module ContextDev
       #
       # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param timeout_opts [ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       # @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur
       #
@@ -610,7 +696,7 @@ module ContextDev
             include_subdomains: "includeSubdomains",
             max_links: "maxLinks",
             sitemap_url: "sitemapUrl",
-            timeout_ms: "timeoutMS",
+            timeout_opts: "timeoutOpts",
             url_regex: "urlRegex"
           ),
           model: ContextDev::Models::WebWebScrapeSitemapResponse,

data/lib/context_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContextDev
-  VERSION = "2.16.0"
+  VERSION = "2.17.1"
 end

data/lib/context_dev.rb

@@ -122,6 +122,8 @@ require_relative "context_dev/models/person_enrich_response"
 require_relative "context_dev/models/retry_config"
 require_relative "context_dev/models/utility_prefetch_params"
 require_relative "context_dev/models/utility_prefetch_response"
+require_relative "context_dev/models/web_answers_params"
+require_relative "context_dev/models/web_answers_response"
 require_relative "context_dev/models/web_extract_competitors_params"
 require_relative "context_dev/models/web_extract_competitors_response"
 require_relative "context_dev/models/web_extract_fonts_params"
@@ -147,6 +149,8 @@ require_relative "context_dev/models/web_search_params"
 require_relative "context_dev/models/web_search_response"
 require_relative "context_dev/models/web_web_crawl_md_params"
 require_relative "context_dev/models/web_web_crawl_md_response"
+require_relative "context_dev/models/web_web_scrape_bytes_params"
+require_relative "context_dev/models/web_web_scrape_bytes_response"
 require_relative "context_dev/models/web_web_scrape_html_params"
 require_relative "context_dev/models/web_web_scrape_html_response"
 require_relative "context_dev/models/web_web_scrape_images_params"