Start a full-site crawl
start_crawlUse this when the stored scan covers too little of the site to answer from — one page scanned out of eighty discovered, or a site never crawled — and a site-wide audit is what was asked for. WRITES to this website's Inclusify configuration — never to the site itself: queues one full-site accessibility crawl. The scan worker discovers pages from the website's primary domain and audits up to maxPages of them, which is capped at the plan's audited-page allowance; when a requested maxPages is clamped down to that cap, the response says so. Asynchronous by design: this returns the job id immediately — keep working, then collect the outcome with crawl_summary (progress, coverage, averages, worst pages) and read the findings with list_violations. Safe to retry: if a crawl is already PENDING or CRAWLING it does not start a second one, it returns the running job and its progress. Removes and edits nothing — not pages, not monitoring, not settings. Costs no page allowance; at most 3 crawls per website can be started per day (UTC).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| website | Yes | The website domain as registered in Inclusify, e.g. "example.com". | |
| maxPages | No | Audit at most this many of the discovered pages. Omit for the plan's full audited-page allowance; anything above the allowance is clamped to it and the response says so. |