v10

latestOpenAPI 3.0.02026-08-074780295.0 KB

website-audit

Perform a comprehensive SEO audit on a website

Crawls a URL with Firecrawl (Crawl4AI fallback), performs a multi-category SEO audit (Common SEO Issues, Server & Security, Mobile Usability, Advanced SEO), and returns structured results with scores per category. In multiple mode (deep crawl) with async=true, the route returns 200 immediately and saves results to the database in the background. The route accepts both GET (params in querystring) and POST (params in JSON body).

post/v3/website-audit/

Request body

urlstring

URL to audit (https:// prefixed automatically)

teamIdstring

Team ID (required for async multiple mode)

auditType'single' | 'multiple'

Audit mode: single page or deep multi-page crawl

async'true' | 'false'

Enable async background processing (multiple mode only)

urlsstring[]

Batch of URLs to audit (alternative to url for Audit Selected). Requires teamId.

Response

Union of single-page, preview, async multiple, and sync multiple shapes. additionalProperties is required so fast-json-stringify does not strip nested audit fields.

urlstring

titlestring

suggestedBrandstring

seoAuditobject

screenshotstring nullable

successboolean

messagestring

totalPagesnumber