Run a WWW audit on one or more URLs
create_auditAudit URLs for on-page signals that help AI assistants cite pages, including schema, headings, crawlability, and authority. Returns pending; read with get_audit until complete.
Instructions
Audits the given URLs for the on-page signals that help a page get cited by AI assistants: schema markup, breadcrumbs, heading structure, crawlability, authority signals, reading level and writing style.
Running one is instant; auditing takes under a minute. The audit comes back pending and turns success (or partial / error) once every URL has been checked — read it with get_audit until it does.
Give projectId to bill the audit to that project's workspace plan; leave it out to bill it to the API key holder's own plan. Either way the audited URLs count against that plan's monthly URL quota — get_audit_usage reads it first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| urls | Yes | The URLs to audit, each with its protocol. | |
| projectId | No | Bill the audit to that project's workspace plan instead of the API key holder's own plan. The active project's id is what get_active_project reports. Left out, the key holder's own plan is used. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| status | Yes | pending the moment it is requested; success once every URL succeeded, partial when only some did, error when none did. | |
| endDate | Yes | When it finished, ISO 8601 in UTC. null = not finished yet. | |
| results | Yes | ||
| duration | Yes | How long the audit took, in seconds. | |
| projectId | Yes | The project this audit was billed to. null = run without one. | |
| startDate | Yes | When the audit started, ISO 8601 in UTC. | |
| numberOfUrls | Yes |