enqueue_crawl
Enqueue a new recursive crawl run for a site. Returns the queued CrawlRun, or the already-active run if one is queued or running. Re-crawls are incremental by default: after the first completed crawl, pages whose sitemap lastmod has not moved or that the server answers 304 Not Modified are carried forward at no credit cost. Pass mode="full" to re-fetch every page. Requires a WRITE-scoped token and EDITOR, ADMIN or OWNER role, and consumes crawl credits for pages downloaded.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"siteId": "<siteId>"
},
"name": "enqueue_crawl"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | "incremental" (the site's default unless it turned incremental re-crawls off) fetches only new and changed pages; "full" re-fetches and bills every page. | |
| siteId | Yes | Path parameter siteId. |