Preview Sitemap URLs

POST 
/knowledge-bases/crawler/sitemap-preview

Returns a paginated, searchable list of sitemap URLs without starting a crawl. WHEN TO USE: use this when you need to preview sitemap URLs before a crawl; use discoverWebsite to start discovery; use trainDiscoveredUrls after pages are found. RETURNS: a paginated list of sitemap URLs.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

knowledgeBaseIdstring

Knowledge base ID

urlstringrequired

Website URL to preview sitemap for

optionstringrequired
Crawl mode
Available optionsExactPathDomain
pagenumber

Page number (1-based)

pageSizenumber

Number of URLs per page (10–200)

searchstring

Substring filter applied to URLs

Example (auto)

{
  "locationId": "tDtDnQdgm2LXpyiqYvZ6",
  "knowledgeBaseId": "tDtDnQdgm2LXpyiqYvZ6",
  "url": "https://example.com",
  "option": "Path",
  "page": 1,
  "pageSize": 100,
  "search": "/blog"
}

application/json

Sitemap preview fetched successfully

application/json

Schema

Schema

hasSitemapbooleanrequired

Whether a sitemap was found for the URL

reasonstring
Machine-readable reason when the preview is empty or degraded
Available optionsNO_SITEMAPFETCH_FAILEDFILTERED_EMPTYSEARCH_EMPTY
sourcestring
Where the sitemap URL list came from
Available optionssitemapcache
cachedboolean

Whether the raw sitemap URL list was served from preview cache

urlsstring[]required

Paginated slice of matching URLs

totalnumberrequired

Total number of URLs after mode-filter and search

pagenumberrequired

Current page number (1-based)

pageSizenumberrequired

Page size used

totalSitemapUrlsnumber

Total URLs found in the raw sitemap before mode/search filtering

modeFilteredTotalnumber

Total URLs after Path/Domain mode filtering before search filtering

Example (auto)

{
  "hasSitemap": true,
  "reason": "NO_SITEMAP",
  "source": "sitemap",
  "cached": false,
  "urls": [
    "https://example.com/page-1",
    "https://example.com/page-2"
  ],
  "total": 42,
  "page": 1,
  "pageSize": 100,
  "totalSitemapUrls": 150,
  "modeFilteredTotal": 80
}