Overview
The Crawl Readiness API reports whether AI crawlers can reach one of your brand’s domains, based on the brand’s most recent finished crawl of that domain. It returns the same signals the AI Access card shows in the Scrunch dashboard. Use it to check from your own backend whether a customer’s site is reachable by AI crawlers before investing in AI visibility work, or to surface readiness inside a partner integration. The endpoint is read-only. Nothing about how readiness is computed changes when you call it.What the Crawl Readiness API includes
- Whether a
robots.txtfile was found for the domain - Whether the site turns crawlers away at the server level (based on HTTP 403 rates across the crawl)
- Whether the site renders mostly client-side, which limits what non-JavaScript crawlers can read
- A sample of pages that
robots.txtblocks, with the AI assistant families (OpenAI, Meta, Perplexity, Gemini, Claude) blocked from each
When to use the Crawl Readiness API
Use the Crawl Readiness API when you need to:- Check whether a brand’s domain is reachable by AI crawlers from a partner backend or CMS integration
- Flag robots.txt rules that block AI assistants from specific pages
- Detect sites that render client-side and may appear empty to non-JavaScript crawlers
Endpoint
The endpoint requires a bearer token with the
query scope. See Authentication.
Pass the optional domain query parameter to choose which of the brand’s domains to describe. Omit it for the brand’s primary website.
Example: check the primary website
Reading the response
Two fields are easy to misread:robots_txt_present: falsemeans permissive, not blocked. With no robots.txt, crawlers are allowed by default.blocked_pagesis a sample, not a complete list. Only the 50 shallowest pages of the crawl are checked against robots.txt. Whenpages_truncatedistrue, the crawl held more pages than that, so an empty or short list does not prove nothing else on the site is blocked.
Limits and behavior
- The response is
nullwhen the brand owns the requested domain but no crawl of it has finished yet. - Requesting a domain the brand does not own returns
404. An unknownbrand_idalso returns404. - Signals come from the brand’s most recent finished crawl of the domain, not a live probe.
- Pass
domainas a bare hostname such asshop.example.com. A value with a path or port may not match any of the brand’s domains and returns404.