Audits Beginner
Audit a Domain Submit a domain for AEO audit, poll until complete, and retrieve the full results with scores and findings.
Overview This example shows the three-step flow for running an audit programmatically: submit the domain, poll for completion, and retrieve the results. The same pattern works in any language with HTTP support.
Full Example curl Python TypeScript
curl -X POST https://www.aeocontent.ai/api/v1/audits \
-H "Authorization: Bearer $AEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain": "example.com"}'Response The completed audit response includes the overall score, per-criterion scores, detailed findings, and recommendations.
audit response (abbreviated) {
class ="code-string">"data": {
class ="code-string">"slug": class ="code-string">"example-com",
class ="code-string">"domain": class ="code-string">"example.com",
class ="code-string">"audit": {
class ="code-string">"overall_score": 67 ,
class ="code-string">"verdict": class ="code-string">"Average",
class ="code-string">"scorecard": [
{ class ="code-string">"criterion": class ="code-string">"Schema.org Markup", class ="code-string">"score": 8 , class ="code-string">"max": 10 },
{ class ="code-string">"criterion": class ="code-string">"llms.txt", class ="code-string">"score": 0 , class ="code-string">"max": 10 },
{ class ="code-string">"criterion": class ="code-string">"Q&A Content Format", class ="code-string">"score": 7 , class ="code-string">"max": 10 }
]
}
}
}Include Fix Prompts Add the include=fix_prompts query parameter to receive actionable remediation advice alongside the audit results.
curl "https: \
-H "Authorization: Bearer $AEO_API_KEY" Fix prompts are sorted by potential impact. Start with the top 3 to get the biggest score improvement with the least effort.
