Sitemap parser, URL extractor: documentation URLs from a bounded XML sitemap
sitemapSitemap parser: reads one public XML sitemap or sitemap index as structured URLs and source-reported dates. Supports gzip, substring filtering and pagination. Large sitemaps are read from the start (512 KiB, 1000 entries at most, with a warning). Does not crawl pages or follow child sitemaps. Invalid XML and execution errors are not charged; a valid empty match is charged. Use to find which pages of a docs site to read before calling /extract. Example: url=https://www.sitemaps.org/sitemap.xml. Price $0.002/call via x402 USDC or a card key (/credits), first 25 free; failed calls free. Reads or computes only and changes nothing; each call is charged, so repeats are not free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Absolute public HTTP(S) XML sitemap URL; child sitemaps are not fetched automatically | |
| offset | No | Offset into distinct reported matching locations (0-1000, default 0); use nextOffset to continue | |
| maxUrls | No | Reported matching locations examined in one page (1-100, default 25); invalid/nonpublic locations may reduce returned entries | |
| contains | No | Optional case-insensitive URL substring, at most 200 characters |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| kind | Yes | ||
| text | Yes | ||
| format | Yes | ||
| offset | Yes | ||
| entries | Yes | ||
| hasMore | Yes | ||
| contains | Yes | ||
| finalUrl | Yes | ||
| warnings | Yes | ||
| fetchedAt | Yes | ||
| hashFormat | Yes | ||
| nextOffset | Yes | ||
| sourceHash | Yes | ||
| contentHash | Yes | ||
| reportedEntries | Yes | ||
| rejectedLocationsInPage | Yes | ||
| uniqueReportedLocations | Yes | ||
| matchingReportedLocations | Yes | Distinct reported locations matching contains, before public-URL validation of the selected page. | |
| missingOrInvalidLocations | Yes | ||
| duplicateReportedLocations | Yes |