@@ -2170,6 +2170,7 @@ def web_scrape_sitemap(
21702170 domain : str ,
21712171 headers : Dict [str , str ] | Omit = omit ,
21722172 max_links : int | Omit = omit ,
2173+ search : str | Omit = omit ,
21732174 sitemap_url : str | Omit = omit ,
21742175 tags : SequenceNotStr [str ] | Omit = omit ,
21752176 timeout_ms : int | Omit = omit ,
@@ -2182,8 +2183,13 @@ def web_scrape_sitemap(
21822183 extra_body : Body | None = None ,
21832184 timeout : float | httpx .Timeout | None | NotGiven = not_given ,
21842185 ) -> WebWebScrapeSitemapResponse :
2185- """
2186- Crawl an entire website's sitemap and return all discovered page URLs.
2186+ """Crawl an entire website's sitemap and return all discovered page URLs.
2187+
2188+ Pass
2189+ `search` to have the crawled sitemap filtered down to the pages about a phrase
2190+ (for example `pricing and plans` or `api authentication docs`), most relevant
2191+ first — a searched crawl scans the whole sitemap and costs 2 credits instead
2192+ of 1.
21872193
21882194 Args:
21892195 domain: Domain to build a sitemap for
@@ -2195,6 +2201,10 @@ def web_scrape_sitemap(
21952201 max_links: Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
21962202 Minimum is 1, maximum is 100,000.
21972203
2204+ search: Optional search phrase. When provided, the crawled sitemap is filtered to the
2205+ pages whose URLs are about that phrase, most relevant first, and the request
2206+ costs 2 credits instead of 1.
2207+
21982208 sitemap_url: Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
21992209 instead of discovering the domain's sitemaps.
22002210
@@ -2234,6 +2244,7 @@ def web_scrape_sitemap(
22342244 "domain" : domain ,
22352245 "headers" : headers ,
22362246 "max_links" : max_links ,
2247+ "search" : search ,
22372248 "sitemap_url" : sitemap_url ,
22382249 "tags" : tags ,
22392250 "timeout_ms" : timeout_ms ,
@@ -4371,6 +4382,7 @@ async def web_scrape_sitemap(
43714382 domain : str ,
43724383 headers : Dict [str , str ] | Omit = omit ,
43734384 max_links : int | Omit = omit ,
4385+ search : str | Omit = omit ,
43744386 sitemap_url : str | Omit = omit ,
43754387 tags : SequenceNotStr [str ] | Omit = omit ,
43764388 timeout_ms : int | Omit = omit ,
@@ -4383,8 +4395,13 @@ async def web_scrape_sitemap(
43834395 extra_body : Body | None = None ,
43844396 timeout : float | httpx .Timeout | None | NotGiven = not_given ,
43854397 ) -> WebWebScrapeSitemapResponse :
4386- """
4387- Crawl an entire website's sitemap and return all discovered page URLs.
4398+ """Crawl an entire website's sitemap and return all discovered page URLs.
4399+
4400+ Pass
4401+ `search` to have the crawled sitemap filtered down to the pages about a phrase
4402+ (for example `pricing and plans` or `api authentication docs`), most relevant
4403+ first — a searched crawl scans the whole sitemap and costs 2 credits instead
4404+ of 1.
43884405
43894406 Args:
43904407 domain: Domain to build a sitemap for
@@ -4396,6 +4413,10 @@ async def web_scrape_sitemap(
43964413 max_links: Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
43974414 Minimum is 1, maximum is 100,000.
43984415
4416+ search: Optional search phrase. When provided, the crawled sitemap is filtered to the
4417+ pages whose URLs are about that phrase, most relevant first, and the request
4418+ costs 2 credits instead of 1.
4419+
43994420 sitemap_url: Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
44004421 instead of discovering the domain's sitemaps.
44014422
@@ -4435,6 +4456,7 @@ async def web_scrape_sitemap(
44354456 "domain" : domain ,
44364457 "headers" : headers ,
44374458 "max_links" : max_links ,
4459+ "search" : search ,
44384460 "sitemap_url" : sitemap_url ,
44394461 "tags" : tags ,
44404462 "timeout_ms" : timeout_ms ,
0 commit comments