API ReferenceSitemap

Get sitemap job status

GET
/v1/sitemap/{id}

Authorization

AuthorizationRequiredBearer <token>

API key. Obtain from POST /v1/account/api-keys.

In: header

Path Parameters

idRequiredstring
Pattern: "^sm_"
curl -X GET "https://api.bytekit.com/v1/sitemap/string" \
  -H "Authorization: Bearer <token>"

Successful response.

{
  "id": "sm_01j9abc123",
  "url": "string",
  "strategy": "string",
  "max_depth": 0,
  "max_urls": 0,
  "status": "pending",
  "total_urls": 0,
  "sources": {},
  "total_bytes": 0,
  "results_url": "string",
  "warnings": [
    "string"
  ],
  "error_code": "string",
  "error_message": "string",
  "compact": true,
  "process": {},
  "metadata": {},
  "created_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z"
}

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-RapidCrawl-Event: sitemap.completed` or `X-RapidCrawl-Event: sitemap.failed` so receivers can dispatch on the header without parsing the body shape.

Client

Instantiate and configure the Bytekit TypeScript client.