Sitemap
Sitemap API — endpoints, requests, and responses.
For AI agents: https://bytekit.com/llms.txt — every docs page is available as markdown by appending .md
The Sitemap API. 2 endpoints:
GET /v1/monitors/{id}/capturesList monitor captures
Previous Page
POST /v1/sitemapDiscover URLs on a domain
Crawls a domain to build a sitemap. Returns cached results if available within cache_ttl. Results delivered via webhook and downloadable from results_url. Webhook deliveries include `X-ByteKit-Event: sitemap.completed` or `X-ByteKit-Event: sitemap.failed` so receivers can dispatch on the header without parsing the body shape. The webhook body is `{ event, data }`. For a job the worker ran, `data` is not a `SitemapResponse`: - `sitemap.completed` `data` carries `id`, `url`, `strategy`, `status`, `total_urls`, `sources`, `total_bytes`, `results_url`, `warnings`, `metadata`, `compact` and `billing`. - `sitemap.failed` `data` carries `id`, `url`, `strategy`, `status`, `error_code`, `error_message`, `warnings` and `metadata`. In both, `url` is the host as `scheme://host`, and `warnings` is the worker's own warnings or `null`. When the request is answered from a cached job (`cache: hit`), the `sitemap.completed` `data` is instead the full job object, the same fields as a `SitemapResponse`. **Limits:** request bodies are capped at 512 KB. An oversized body returns a `400` with error code `request_too_large`.