Sitemap

Functions for interacting with the sitemap API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.

Create Sitemap

Discover 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.

Limits: request bodies are capped at 512 KB. An oversized body returns a 400 with error code request_too_large.

Parameters

• body (SitemapRequest)

Call styles

sync_detailed(client=client, body=body) -> Response[Union[Error, SitemapResponse]]
sync(client=client, body=body) -> Optional[Union[Error, SitemapResponse]]
await asyncio_detailed(client=client, body=body) -> Response[Union[Error, SitemapResponse]]
await asyncio(client=client, body=body) -> Optional[Union[Error, SitemapResponse]]

Get Sitemap

Get sitemap job status

Parameters

• id (str)

Call styles

sync_detailed(id=id, client=client) -> Response[Union[Error, SitemapResponse]]
sync(id=id, client=client) -> Optional[Union[Error, SitemapResponse]]
await asyncio_detailed(id=id, client=client) -> Response[Union[Error, SitemapResponse]]
await asyncio(id=id, client=client) -> Optional[Union[Error, SitemapResponse]]