Audits

Start a technical audit

Enqueues an asynchronous technical SEO audit (a site crawl runs first when no usable crawl exists). Returns 202 with an audit_id to poll at GET /v1/audits/{audit_id}. If an audit is already queued/running for the project, that run is returned as-is (202, no duplicate job, no budget burn). Sandbox trial: 1 audit per key. Non-sandbox projects: included with an active subscription; without one, LIVE keys pay per unit from the prepaid credit balance (technical_audit = 25 credits — 402 insufficient_credits when the balance is short). Typical completion: a few minutes; poll every 30–60s.

post/v1/projects/{projectId}/audits

Request

  • Base URL: https://serp-agent.com
  • URL: https://serp-agent.com/v1/projects/{projectId}/audits
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Project id.

Headers

Idempotency-Keystring

Any unique string (max 200 chars). Retrying a request with the same key replays the stored response verbatim (with header Idempotent-Replayed: true) instead of re-executing — including one-time secrets in the original body. Keys are scoped per account (per client IP on the unauthenticated signup) and pruned after 24h. Reusing a key on a different endpoint returns 409 idempotency_conflict.

Response

Audit queued (or an already-active run returned). Poll the poll path.

audit_idstring required
status'queued' | 'running' required

"running" when an already-active run was returned.

pollstring required

Path to poll: GET /v1/audits/{audit_id}.

Changes

No recorded changes to this operation across all 1 revision of this API.