Run a WWW audit on one or more URLs
create_auditAudits 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.
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.
Users pay for audits only with their plan's monthly URL quota — each audited URL consumes 1 unit of the limit shown by get_audit_usage. Check get_audit_usage first; a request with more URLs than remaining is rejected with 402 plan_limit_exceeded. Give projectId to bill to that project's workspace plan; leave it out to bill to the API key holder's own plan.
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 project's id is what list_projects 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 |