POST /utility/prefetch as soon as you know the domain or email, then set type to "brand" before /brand/retrieve or "styleguide" before /web/styleguide. The identifier object takes exactly one of domain or email:
/brand/retrieve returns instantly.
0 Credits. Ordinary API rate limit applies. Subscriber-only.
How the cache works
- Cache TTL is up to 3 months. After that, the next call triggers a refresh in the background.
- The cache is shared across the account. A prefetch from a backend job warms the cache for a user-facing call seconds later.
- Prefetch is fire-and-forget. The endpoint returns immediately after queuing the work. You do not wait for the prefetch before calling
/brand/retrieveor/web/styleguide. - Low timeouts fail fast on cold domains. A
/brand/retrievewithtimeoutMSbelow 10,000 ms on a domain that isn’t cached yet returns an immediate422(COLD_DOMAIN_TIMEOUT_TOO_LOW) instead of a guaranteed 408 — a cold crawl can never finish that fast. Prefetching is the fix: once the cache is warm, low-timeout lookups succeed. - Prefetch by email skips known free/disposable providers. Calls against
gmail.com,yahoo.com,outlook.com, and the 10,000+ disposable services return a422(FREE_EMAIL_DETECTEDorDISPOSABLE_EMAIL_DETECTED) that you can safely ignore. - Provide exactly one identifier. Sending both
domainandemail(or neither) returns a400.
Latency
Prefetch moves cold crawl work ahead of the user-facing lookup. Warm-cache responses are generally faster, but exact latency depends on the target site, cache state, region, and requested work. SettimeoutMS for your application budget; the platform maximum is five minutes.
What prefetch does not do
- It does not speed up general scraping endpoints.
type: "styleguide"specifically warms/web/styleguide;/web/scrape/*,/web/crawl,/web/screenshot, and/brand/ai/*still fetch the target URL. - It does not preempt rate limits. Prefetch costs 0 API credits but still counts against your ordinary per-minute API limit, as does the eventual
/brand/retrievecall. - It does not return brand or styleguide data. The endpoint queues the work and returns
{ status, message, type, domain, key_metadata }. Read the result later from/brand/retrieveor/web/styleguide.
Related resources
Rate limits
How the per-plan per-minute limits interact with cached and prefetched
calls.
Best practices
Where prefetching fits in the broader integration pattern.
Troubleshooting
Cold-hit timeouts and how to handle them.
Get brand data
The endpoint prefetching warms.