Create Audit
/api/v1/audits/
Creates a new audit. If competitors and market are provided, the audit pipeline starts immediately. Otherwise, it waits for configuration via chat.
Website URL to audit
Target market (e.g., “US”, “UK”, “AR”)
Content language (e.g., “en”, “es”, “fr”)
List of competitor domains
Unique audit identifier
Audited website URL
Current status:
pending, running, completed, failedProgress percentage (0-100)
List Audits
GET/api/v1/audits/
Returns a paginated list of your audits.
Number of records to skip
Maximum records to return
Array of audit summary objects
Get Audit Details
GET/api/v1/audits/{audit_id}
Returns full audit details including pages, scores, and fix plan.
Audit ID
Audited URL
Current status
GEO optimization score (0-100)
Number of pages audited
Actionable fixes with priority levels
Detailed audit data for the target site
Get Audit Status
GET/api/v1/audits/{audit_id}/status
Lightweight endpoint for polling audit progress.
Audit ID
Current status
Progress percentage
Current GEO score
Get Fix Plan
GET/api/v1/audits/{audit_id}/fix_plan
Returns the actionable fix plan in JSON format.
Array of fix items with details
Delete Audit
DELETE/api/v1/audits/{audit_id}
Permanently deletes an audit and associated data.
Get Audit Pages
GET/api/v1/audits/{audit_id}/pages
Returns all audited pages with scores and issues.
Array of page objects with audit data
Get Competitors
GET/api/v1/audits/{audit_id}/competitors
Returns competitor analysis data with GEO scores.
Maximum competitors to return (max: 10)
Array of competitor objects with GEO scores
Run PageSpeed Analysis
POST/api/v1/audits/{audit_id}/pagespeed
Triggers PageSpeed Insights analysis and returns complete data.
Analysis strategy:
mobile, desktop, or bothWhether analysis completed
Complete PageSpeed data with all metrics, opportunities, diagnostics
Generate PDF Report
POST/api/v1/audits/{audit_id}/generate-pdf
Generates a comprehensive PDF report with PageSpeed, keywords, backlinks, and GEO analysis.
Force refresh PageSpeed data
Force regenerate report markdown
Force refresh external intelligence data
Whether PDF generation succeeded
Supabase storage path (supabase://…)
PDF file size in bytes
Whether PageSpeed data was included
Download PDF
GET/api/v1/audits/{audit_id}/download-pdf
Redirects to signed Supabase download URL for the PDF report.
Get PDF Download URL
GET/api/v1/audits/{audit_id}/download-pdf-url
Returns a signed download URL without redirecting.
Signed URL valid for 1 hour
URL expiration time
Storage provider (“supabase”)
Configure Audit via Chat
POST/api/v1/audits/chat/config
Configures audit settings and launches the pipeline.
Audit ID to configure
Content language
Competitor domains
Target market
Error Codes
Bad request or invalid parameters
Missing or invalid authentication token
Access denied (cross-user access)
Audit not found
PDF generation already in progress
Missing required fix inputs
Database or Redis temporarily unavailable