Start a whole-site scan
start_site_scanStart a whole-site scan for the signed-in person's account: Bot Appétit reads a representative sample of the site (not every page) and scores it. Needs the person to have authorised this connection. It returns a job_id straight away and the scan runs in the background, so read it with site_scan_status. A full scan of a large site usually takes about 2 and a half minutes and nine in ten finish within about 5 and a half minutes; a site of ten pages or fewer usually finishes in under half a minute. Do not poll: the first answer asks for one check after 30 seconds, and if the scan is still running the next answer says how long to wait. Read check_again_after_seconds in the answer and wait that long before the next check. The result is private to their account until they choose to share it. For one page, use scan_page, which needs no account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | The site to scan: a domain such as example.com, a sitemap URL, or a list of pages on ONE site, one per line. |