context.dev 2.21.0 → 2.22.0

data/lib/context_dev/resources/web.rb

@@ -6,25 +6,22 @@ module ContextDev
       # 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.
+      # Research the web and return a sourced answer in your JSON shape. Choose `fast`
+      # for a short task or `ultra` for deeper research.
       #
       # @overload answers(task:, json_format: nil, mode: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #
-      # @param task [String] What to research and answer, in plain language. Naming a domain in the task (for
+      # @param task [String] Research task. The agent selects company/profile lookups, web searches, or page
       #
-      # @param json_format [Hash{Symbol=>Object}] An example object with placeholder values (for example {"pricing_page_url": "",
+      # @param json_format [Hash{Symbol=>Object}] Example answer object, not JSON Schema. Up to 8 levels, 500 values, and 16000 ch
       #
-      # @param mode [Symbol, ContextDev::Models::WebAnswersParams::Mode] Research level: fast uses a smaller model and research budget for 10 credits; ul
+      # @param mode [Symbol, ContextDev::Models::WebAnswersParams::Mode] `fast` prioritizes speed, with extra verification for people and companies; `ult
       #
-      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      # @param tags [Array<String>] Labels for filtering usage in the dashboard.
       #
-      # @param timeout_opts [ContextDev::Models::WebAnswersParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      # @param timeout_opts [ContextDev::Models::WebAnswersParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      # @param zdr [Symbol, ContextDev::Models::WebAnswersParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      # @param zdr [Symbol, ContextDev::Models::WebAnswersParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -54,11 +51,11 @@ module ContextDev
       #
       # @param num_competitors [Integer] Exact number of direct competitors to return. Defaults to 5.
       #
-      # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
-      # @param timeout_opts [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      # @param timeout_opts [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      # @param zdr [Symbol, ContextDev::Models::WebExtractCompetitorsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      # @param zdr [Symbol, ContextDev::Models::WebExtractCompetitorsParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -80,24 +77,23 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebExtractStyleguideParams} for more details.
       #
-      # Extract a comprehensive design system from a website including colors,
-      # typography, spacing, shadows, and UI components.
+      # Extract colors, typography, spacing, and component styles from a website.
       #
       # @overload extract_styleguide(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #
       # @param color_scheme [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme] Optional browser color scheme to emulate for websites that respond to prefers-co
       #
-      # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio
+      # @param direct_url [String] Exact URL to inspect. Provide either `domain` or `directUrl`, not both.
       #
       # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The
       #
-      # @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
+      # @param max_age_ms [Integer, nil] Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1 yea
       #
-      # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
-      # @param timeout_opts [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      # @param timeout_opts [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      # @param zdr [Symbol, ContextDev::Models::WebExtractStyleguideParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      # @param zdr [Symbol, ContextDev::Models::WebExtractStyleguideParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -124,36 +120,30 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebMapURLsParams} for more details.
       #
-      # Discovers URLs using the same sitemap crawl, filters, and limits as
-      # /web/scrape/sitemap. Each URL includes its available title, description,
-      # keywords, and language. URLs without stored enrichment are returned immediately
-      # with only the URL and queued for background HTML scraping, so later requests can
-      # include their metadata. Responses are never cached as a whole; every request
-      # reads the current per-URL enrichment. Zero data retention and credential-bearing
-      # discovery requests return URLs without reading or storing shared enrichment or
-      # queuing background scrapes. Costs 1 credit, or 2 credits with search.
+      # Discover a site's URLs, with page titles, descriptions, keywords, and language
+      # when available. Metadata can be missing on newly discovered URLs.
       #
       # @overload map_urls(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
+      # @param domain [String] Domain to map, e.g. `stripe.com`.
       #
-      # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
+      # @param headers [Hash{Symbol=>String}] HTTP headers for the target origin. Non-empty headers bypass caching.
       #
-      # @param include_subdomains [Boolean] When true, discover and include public pages and sitemaps on subdomains of the r
+      # @param include_subdomains [Boolean] Include URLs on subdomains.
       #
-      # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
+      # @param max_links [Integer] Maximum number of URLs to return.
       #
-      # @param search [String] Optional search phrase. When provided, the crawled sitemap is filtered to the pa
+      # @param search [String] Filter URLs by a topic or phrase, most relevant first.
       #
-      # @param sitemap_url [String] Optional explicit sitemap URL. When provided, exactly this sitemap is crawled in
+      # @param sitemap_url [String] Fetch this sitemap instead of discovering sitemaps. Must belong to the domain or
       #
-      # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
-      # @param timeout_opts [ContextDev::Models::WebMapURLsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      # @param timeout_opts [ContextDev::Models::WebMapURLsParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
       # @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur
       #
-      # @param zdr [Symbol, ContextDev::Models::WebMapURLsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      # @param zdr [Symbol, ContextDev::Models::WebMapURLsParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -181,56 +171,38 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebScrapeParams} for more details.
       #
-      # Reuse cached outputs independently and capture missing formats in one page
-      # visit. Each cache key includes only the settings that affect that output. HTML
-      # is shared with Markdown, parsed fields, product data, highlights, and JSON
-      # extraction. Cached outputs can come from different visits within maxAgeMs; use 0
-      # for a fresh capture. HTML-only requests use the existing fast acquisition path.
-      # Highlights return Markdown excerpts most relevant to highlightsParams.query.
-      # Requests with at least one successful output cost one base credit, including
-      # cache hits, or two with browser actions. All-failed responses are unbilled
-      # except missing pages, which retain the base price and the one-credit product
-      # charge when product was requested. Highlights add 3 credits when passages are
-      # returned. JSON extraction runs an LLM over nonempty page Markdown and adds four
-      # credits only when its result is returned successfully. PDF OCR adds one credit
-      # per recovered page on fresh extraction. Product adds one credit when its
-      # successful result is returned, plus six if that result used the specialized
-      # model. Original response bytes and screenshots are limited to 20 MiB each,
-      # screenshots to 40 megapixels, and the combined response to 60 MiB. An oversized
-      # output has success: false and data: null. If the combined response exceeds its
-      # limit, the largest outputs are marked failed until the remaining outputs fit.
-      # Valid captured pieces may still be cached when omitted to meet the response size
-      # limit.
+      # Scrape anything from a URL on the internet. Returns the outputs you enable in
+      # formats. Handles PDFs, DOCX, PPT, XLSX, and 40 other file formats.
       #
       # @overload scrape(formats:, url:, highlights_params: nil, image_params: nil, json_params: nil, markdown_params: nil, max_age_ms: nil, parse_params: nil, product_params: nil, screenshot_params: nil, shared_params: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #
-      # @param formats [ContextDev::Models::WebScrapeParams::Formats] Outputs to return. Enable at least one; omitted formats are false.
+      # @param formats [ContextDev::Models::WebScrapeParams::Formats] Outputs to return. Set at least one to `true`.
       #
-      # @param url [String] The URL to scrape.
+      # @param url [String] Public HTTP or HTTPS URL to scrape.
       #
-      # @param highlights_params [ContextDev::Models::WebScrapeParams::HighlightsParams] Highlight options. Requires formats.highlights: true.
+      # @param highlights_params [ContextDev::Models::WebScrapeParams::HighlightsParams] Requires `formats.highlights: true`; required when it is set.
       #
       # @param image_params [ContextDev::Models::WebScrapeParams::ImageParams] Image options. Requires formats.images: true.
       #
-      # @param json_params [ContextDev::Models::WebScrapeParams::JsonParams] Required when formats.json is true.
+      # @param json_params [ContextDev::Models::WebScrapeParams::JsonParams] Requires `formats.json: true`; required when it is set.
       #
-      # @param markdown_params [ContextDev::Models::WebScrapeParams::MarkdownParams] Markdown options. Requires formats.markdown: true.
+      # @param markdown_params [ContextDev::Models::WebScrapeParams::MarkdownParams] Markdown options. Requires `formats.markdown`.
       #
-      # @param max_age_ms [Integer] Maximum age of each cached output. Defaults to 1 day; 0 fetches fresh and update
+      # @param max_age_ms [Integer] Maximum age of a cached output, in milliseconds. `0` fetches fresh. Defaults to
       #
-      # @param parse_params [ContextDev::Models::WebScrapeParams::ParseParams] Required when formats.parse is true.
+      # @param parse_params [ContextDev::Models::WebScrapeParams::ParseParams] Requires `formats.parse: true`; required when it is set.
       #
       # @param product_params [ContextDev::Models::WebScrapeParams::ProductParams] Product options. Requires formats.product: true.
       #
       # @param screenshot_params [ContextDev::Models::WebScrapeParams::ScreenshotParams] Screenshot options. Requires formats.screenshot: true.
       #
-      # @param shared_params [ContextDev::Models::WebScrapeParams::SharedParams] Shared browser and content settings. Content filters leave screenshots and origi
+      # @param shared_params [ContextDev::Models::WebScrapeParams::SharedParams] Browser and content settings shared by all outputs.
       #
       # @param tags [Array<String>] Labels for tracking request usage. Not retained when zdr is enabled.
       #
-      # @param timeout_opts [ContextDev::Models::WebScrapeParams::TimeoutOpts] Total deadline, including navigation, actions, waiting, and all outputs. Default
+      # @param timeout_opts [ContextDev::Models::WebScrapeParams::TimeoutOpts] Deadline for the whole request. Defaults to 60000 ms with `fail`. Fixed waits mu
       #
-      # @param zdr [Symbol, ContextDev::Models::WebScrapeParams::Zdr] Zero data retention. Bypasses caches and uploads; excludes request/response cont
+      # @param zdr [Symbol, ContextDev::Models::WebScrapeParams::Zdr] `enabled` turns on zero data retention. Your organization must have ZDR enabled.
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -259,7 +231,7 @@ module ContextDev
       #
       # @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig
       #
-      # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
+      # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Fetch from this country (ISO 3166-1 alpha-2).
       #
       # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
       #
@@ -277,15 +249,15 @@ module ContextDev
       #
       # @param scroll_offset [Integer, nil] Optional vertical scroll offset in pixels for capturing a long page in viewport-
       #
-      # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
-      # @param timeout_opts [ContextDev::Models::WebScreenshotParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      # @param timeout_opts [ContextDev::Models::WebScreenshotParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
       # @param viewport [ContextDev::Models::WebScreenshotParams::Viewport] Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
       #
       # @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load before taking
       #
-      # @param zdr [Symbol, ContextDev::Models::WebScreenshotParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      # @param zdr [Symbol, ContextDev::Models::WebScreenshotParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -317,31 +289,34 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebSearchParams} for more details.
       #
-      # Search the web and optionally scrape each result to Markdown in one round-trip.
+      # Search the web and optionally return page content or relevant passages with each
+      # result.
       #
-      # @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, zdr: nil, request_options: {})
+      # @overload search(query:, country: nil, exclude_domains: nil, freshness: nil, highlights_options: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #
       # @param query [String] Search query. Accepts natural language as well as Google-style search operators
       #
       # @param country [Symbol, ContextDev::Models::WebSearchParams::Country] Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific cou
       #
-      # @param exclude_domains [Array<String>] Blocklist — drop results from these domains. Example: ["pinterest.com", "reddit.
+      # @param exclude_domains [Array<String>] Blocklist — drop results from these domains. Up to 100 domains. Example: ["pinte
       #
       # @param freshness [Symbol, ContextDev::Models::WebSearchParams::Freshness] Restrict results to content published within this window.
       #
-      # @param include_domains [Array<String>] Allowlist — only return results from these domains. Example: ["arxiv.org", "gith
+      # @param highlights_options [ContextDev::Models::WebSearchParams::HighlightsOptions] Passages from each result page that are relevant to the query. Pages are read wi
+      #
+      # @param include_domains [Array<String>] Allowlist — only return results from these domains. Up to 100 domains. Example:
       #
       # @param markdown_options [ContextDev::Models::WebSearchParams::MarkdownOptions] Inline Markdown scraping for each result. Set `enabled: true` to activate.
       #
       # @param num_results [Integer] Number of results to request and return (10–100). Defaults to 10.
       #
-      # @param query_fanout [Boolean] Expand the query into multiple parallel variants for broader recall.
+      # @param query_fanout [Boolean] Currently has no effect.
       #
-      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      # @param tags [Array<String>] Labels for filtering usage in the dashboard.
       #
-      # @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      # @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      # @param zdr [Symbol, ContextDev::Models::WebSearchParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      # @param zdr [Symbol, ContextDev::Models::WebSearchParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -362,16 +337,16 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebWebCrawlMdParams} for more details.
       #
-      # Performs a crawl starting from a given URL, extracts page content as Markdown,
-      # and returns results for all crawled pages.
+      # Crawl a website and return page content as Markdown. Use a batch for crawls
+      # beyond 500 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_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)
+      # @param url [String] Start URL, including `http://` or `https://`.
       #
-      # @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
+      # @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Fetch from this country (ISO 3166-1 alpha-2).
       #
-      # @param exclude_selectors [Array<String>] CSS selectors to remove before each crawled page is converted to Markdown. Appli
+      # @param exclude_selectors [Array<String>] Remove matching elements after inclusions. Exclusions take precedence.
       #
       # @param follow_subdomains [Boolean] When true, follow links on subdomains of the starting URL's domain (e.g. docs.ex
       #
@@ -381,25 +356,25 @@ module ContextDev
       #
       # @param include_links [Boolean] Preserve hyperlinks in the Markdown output
       #
-      # @param include_selectors [Array<String>] CSS selectors. When provided, only matching HTML subtrees (and their descendants
+      # @param include_selectors [Array<String>] Keep matching HTML subtrees before converting each page to Markdown.
       #
-      # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
+      # @param max_age_ms [Integer] Maximum cache age in milliseconds. Defaults to 1 day; `0` fetches fresh.
       #
       # @param max_depth [Integer] Maximum link depth from the starting URL (0 = only the starting page)
       #
-      # @param max_pages [Integer] Maximum number of pages to crawl. Hard cap: 500.
+      # @param max_pages [Integer] Maximum pages to crawl.
       #
-      # @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and embedded-image
+      # @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF handling. `start`/`end` limit parsing to an inclusive, 1-based page range.
       #
-      # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
+      # @param settle_animations [Boolean] Wait briefly for CSS animations and transitions to settle before reading each pa
       #
       # @param shorten_base64_images [Boolean] Truncate base64-encoded image data in the Markdown output
       #
-      # @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. After each scrape, the crawler c
+      # @param stop_after_ms [Integer] Soft crawl deadline in milliseconds. Returns pages collected before the next dea
       #
-      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      # @param tags [Array<String>] Labels for filtering usage in the dashboard.
       #
-      # @param timeout_opts [ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      # @param timeout_opts [ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
       # @param url_regex [String] Regex pattern. Only URLs matching this pattern will be followed and scraped. An
       #
@@ -407,7 +382,7 @@ module ContextDev
       #
       # @param wait_for_ms [Integer] Browser wait time in milliseconds after initial page load for each crawled page.
       #
-      # @param zdr [Symbol, ContextDev::Models::WebWebCrawlMdParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      # @param zdr [Symbol, ContextDev::Models::WebWebCrawlMdParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/context_dev/resources/webhooks/deliveries.rb

@@ -3,18 +3,15 @@
 module ContextDev
   module Resources
     class Webhooks
-      # Inspect and retry webhook deliveries. These endpoints cost no credits.
+      # Inspect and retry batch and monitor webhook deliveries.
       class Deliveries
-        # Some parameter documentations has been truncated, see
-        # {ContextDev::Models::Webhooks::DeliveryRetrieveParams} for more details.
-        #
-        # Get a webhook delivery, including its status and latest attempt.
+        # Retrieve a webhook delivery’s status and original payload.
         #
         # @overload retrieve(delivery_id, tags: nil, request_options: {})
         #
         # @param delivery_id [String] Delivery ID.
         #
-        # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+        # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         #
         # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -33,7 +30,7 @@ module ContextDev
           )
         end
 
-        # List your batch or monitor webhook deliveries, newest first.
+        # List batch and monitor webhook deliveries from the last 30 days.
         #
         # @overload list(body:, request_options: {})
         #
@@ -54,10 +51,7 @@ module ContextDev
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {ContextDev::Models::Webhooks::DeliveryListAttemptsParams} for more details.
-        #
-        # List delivery attempts, newest first.
+        # List a delivery’s attempts, newest first.
         #
         # @overload list_attempts(delivery_id, cursor: nil, limit: nil, tags: nil, request_options: {})
         #
@@ -67,7 +61,7 @@ module ContextDev
         #
         # @param limit [Integer] Number of attempts to return.
         #
-        # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+        # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         #
         # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -86,18 +80,16 @@ module ContextDev
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {ContextDev::Models::Webhooks::DeliveryRetryParams} for more details.
-        #
-        # Retry a webhook delivery within seven days of creation.
+        # Resend the original payload using the source’s current URL and secret. Available
+        # for 7 days after the event.
         #
         # @overload retry_(delivery_id, force: nil, tags: nil, idempotency_key: nil, request_options: {})
         #
         # @param delivery_id [String] Path param: Delivery ID.
         #
-        # @param force [Boolean] Body param: Resend a delivery that already succeeded.
+        # @param force [Boolean] Body param: Resend even if the delivery already succeeded. Defaults to false.
         #
-        # @param tags [Array<String>] Body param: Optional tags for tracking usage. Up to 20 tags, each 1 to 50 charac
+        # @param tags [Array<String>] Body param: Labels for filtering usage in the dashboard.
         #
         # @param idempotency_key [String] Header param: Unique key to prevent duplicate retry requests.
         #

data/lib/context_dev/resources/webhooks.rb

@@ -3,7 +3,7 @@
 module ContextDev
   module Resources
     class Webhooks
-      # Inspect and retry webhook deliveries. These endpoints cost no credits.
+      # Inspect and retry batch and monitor webhook deliveries.
       # @return [ContextDev::Resources::Webhooks::Deliveries]
       attr_reader :deliveries
 

data/lib/context_dev/version.rb

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

data/rbi/context_dev/client.rbi

@@ -28,10 +28,7 @@ module ContextDev
     sig { returns(ContextDev::Resources::Utility) }
     attr_reader :utility
 
-    # Monitor pages, sitemaps, and extracted website data for exact or semantic
-    # changes. Webhook payloads are documented by the
-    # MonitorsChangeDetectedWebhookPayload and MonitorsRunCompletedWebhookPayload
-    # schemas.
+    # Watch websites for exact or meaningful changes.
     sig { returns(ContextDev::Resources::Monitors) }
     attr_reader :monitors
 
@@ -45,17 +42,15 @@ module ContextDev
     sig { returns(ContextDev::Resources::People) }
     attr_reader :people
 
-    # Search live first-party RSS and free historical news data by company identity.
+    # Search live and historical news about a company.
     sig { returns(ContextDev::Resources::News) }
     attr_reader :news
 
-    # Read your organization's API request logs to debug failed calls. These endpoints
-    # cost no credits and use a separate rate limit.
+    # Read your organization's API request logs.
     sig { returns(ContextDev::Resources::Logs) }
     attr_reader :logs
 
-    # Report bugs, docs mismatches, and friction with any Context.dev API. Submissions
-    # cost no credits and use a separate rate limit.
+    # Report API issues and documentation mismatches.
     sig { returns(ContextDev::Resources::Feedback) }
     attr_reader :feedback
 

data/rbi/context_dev/models/batch_cancel_params.rbi

@@ -11,7 +11,7 @@ module ContextDev
           T.any(ContextDev::BatchCancelParams, ContextDev::Internal::AnyHash)
         end
 
-      # ID of the batch to retrieve or cancel.
+      # Batch ID.
       sig { returns(String) }
       attr_accessor :batch_id
 
@@ -22,7 +22,7 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
-        # ID of the batch to retrieve or cancel.
+        # Batch ID.
         batch_id:,
         request_options: {}
       )

data/rbi/context_dev/models/batch_cancel_response.rbi

@@ -15,8 +15,7 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :id
 
-      # The crawl controls as submitted, so the limits requested can be compared against
-      # what the crawl reached.
+      # Crawl settings as submitted.
       sig { returns(T.nilable(ContextDev::CrawlControls)) }
       attr_reader :crawl
 
@@ -40,7 +39,7 @@ module ContextDev
       end
       attr_accessor :format_
 
-      # What submission took in, and what it charged for.
+      # What the submission accepted.
       sig { returns(ContextDev::Intake) }
       attr_reader :input
 
@@ -68,8 +67,8 @@ module ContextDev
       end
       attr_writer :progress
 
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
       sig { returns(String) }
       attr_accessor :request_id
 
@@ -84,7 +83,7 @@ module ContextDev
       sig { returns(T::Array[String]) }
       attr_accessor :tags
 
-      # There is no finish time yet — the batch is still winding down.
+      # Batch timestamps.
       sig { returns(ContextDev::Models::BatchCancelResponse::Timing) }
       attr_reader :timing
 
@@ -130,14 +129,13 @@ module ContextDev
       def self.new(
         # Batch ID.
         id:,
-        # The crawl controls as submitted, so the limits requested can be compared against
-        # what the crawl reached.
+        # Crawl settings as submitted.
         crawl:,
         # What this batch cost so far.
         credits:,
         # What each page is returned as.
         format_:,
-        # What submission took in, and what it charged for.
+        # What the submission accepted.
         input:,
         # How pages were selected.
         mode:,
@@ -145,15 +143,15 @@ module ContextDev
         page_errors:,
         # How far the batch got before cancellation.
         progress:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         request_id:,
         # Always `cancelling`. Work already in flight finishes; the batch reaches
         # `cancelled` shortly after.
         status:,
         # Tags stored on the batch at submission.
         tags:,
-        # There is no finish time yet — the batch is still winding down.
+        # Batch timestamps.
         timing:,
         # API key usage for this request.
         key_metadata: nil
@@ -193,16 +191,14 @@ module ContextDev
             )
           end
 
-        # Credits debited at submission. The unspent remainder is refunded once the batch
-        # settles — read `credits.refunded` from GET /batch/{batch_id} then.
+        # Credits held at submission; unused credits are refunded when the batch settles.
         sig { returns(Integer) }
         attr_accessor :reserved
 
         # What this batch cost so far.
         sig { params(reserved: Integer).returns(T.attached_class) }
         def self.new(
-          # Credits debited at submission. The unspent remainder is refunded once the batch
-          # settles — read `credits.refunded` from GET /batch/{batch_id} then.
+          # Credits held at submission; unused credits are refunded when the batch settles.
           reserved:
         )
         end
@@ -289,7 +285,7 @@ module ContextDev
         sig { returns(Integer) }
         attr_accessor :failed
 
-        # Reserved pages that will now be skipped, and refunded when the batch settles.
+        # Pages that will be skipped.
         sig { returns(Integer) }
         attr_accessor :pending
 
@@ -306,7 +302,7 @@ module ContextDev
         def self.new(
           # Pages that could not be scraped before the request landed.
           failed:,
-          # Reserved pages that will now be skipped, and refunded when the batch settles.
+          # Pages that will be skipped.
           pending:,
           # Pages scraped successfully before the request landed.
           succeeded:
@@ -367,7 +363,7 @@ module ContextDev
         sig { returns(T.nilable(String)) }
         attr_accessor :started_at
 
-        # There is no finish time yet — the batch is still winding down.
+        # Batch timestamps.
         sig do
           params(created_at: String, started_at: T.nilable(String)).returns(
             T.attached_class
@@ -399,7 +395,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -414,7 +410,7 @@ module ContextDev
           )
         end
         def self.new(
-          # Credits used by this request.
+          # Credits charged for this request.
           credits_consumed:,
           # Credits remaining for your organization.
           credits_remaining: