API Reference

Get Audit

Get full audit details including scorecard, findings, and optional fix prompts.

GET/api/v1/audits/[slug]

Get full audit details for a domain, including scorecard, detailed findings, opportunities, and optional fix prompts.

Path Parameters

Name	Type	Required	Description
`slug`	string	Required	Domain slug (e.g., "notion-com")

Query Parameters

Name	Type	Required	Description
`engine`	string	Optional	Filter by engine. Without this param the response is an array of all engines. With this param it returns a single object.
`include`	string	Optional	Set to "fix_prompts" for actionable remediation advice

Code Examples

Basic:

bash

curl "https:">//www.aeocontent.ai/api/v1/audits/notion-com" \
  -H "Authorization: Bearer $AEO_API_KEY"

With fix prompts:

bash

curl "https:">//www.aeocontent.ai/api/v1/audits/notion-com?include=fix_prompts" \
  -H "Authorization: Bearer $AEO_API_KEY"

Try it

Response

Without the engine param, returns an array of all available engine audits. With ?engine=chatgpt, returns a single object.

200Audit data

json

{
  class="code-string">"data": [
    {
      class="code-string">"slug": class="code-string">"notion-com",
      class="code-string">"domain": class="code-string">"notion.com",
      class="code-string">"engine": class="code-string">"chatgpt",
      class="code-string">"overall_score": 62,
      class="code-string">"verdict": class="code-string">"Moderate AEO readiness with notable gaps in structured data.",
      class="code-string">"sector": class="code-string">"saas-productivity",
      class="code-string">"category": class="code-string">"Project Management",
      class="code-string">"scorecard": [
        {
          class="code-string">"id": 1,
          class="code-string">"criterion": class="code-string">"llms.txt",
          class="code-string">"score": 0,
          class="code-string">"status": class="code-string">"fail",
          class="code-string">"keyFindings": class="code-string">"No llms.txt file found at domain root."
        }
      ],
      class="code-string">"detailed_findings": [
        { class="code-string">"id": 1, class="code-string">"name": class="code-string">"llms.txt", class="code-string">"findings": [{ class="code-string">"description": class="code-string">"No /llms.txt file detected..." }] }
      ],
      class="code-string">"opportunities": [
        { class="code-string">"id": class="code-string">"opp-1", class="code-string">"name": class="code-string">"Add llms.txt", class="code-string">"description": class="code-string">"Create an llms.txt file...", class="code-string">"effort": class="code-string">"low", class="code-string">"impact": class="code-string">"high" }
      ],
      class="code-string">"bottom_line": class="code-string">"Notion has strong content but lacks AI-specific signals.",
      class="code-string">"pitch_numbers": null,
      class="code-string">"created_at": class="code-string">"2026-02-15T10:30:00.000Z"
    }
  ],
  class="code-string">"meta": { class="code-string">"request_id": class="code-string">"...", class="code-string">"timestamp": class="code-string">"..." }
}

When include=fix_prompts is set, two additional fields are appended to each audit object.

200With fix_prompts included

json

{
  class="code-string">"data": [
    {
      class="code-string">"...": class="code-string">"...audit fields above...",
      class="code-string">"fix_prompts": [
        {
          class="code-string">"criterion_id": 1,
          class="code-string">"criterion_name": class="code-string">"llms.txt",
          class="code-string">"category": class="code-string">"DISCOVERY",
          class="code-string">"current_score": 0,
          class="code-string">"potential_gain": 10,
          class="code-string">"prompt": class="code-string">"Create a /llms.txt file at your domain root...",
          class="code-string">"webflow_prompt": class="code-string">"In Webflow, create a static page..."
        }
      ],
      class="code-string">"fix_summary": {
        class="code-string">"criteria_to_fix": 8,
        class="code-string">"total_potential_gain": 23,
        class="code-string">"top_3_fixes": [
          class="code-string">"llms.txt (+10pts)",
          class="code-string">"Schema.org Markup (+8pts)",
          class="code-string">"FAQ Section (+5pts)"
        ]
      }
    }
  ],
  class="code-string">"meta": { class="code-string">"request_id": class="code-string">"...", class="code-string">"timestamp": class="code-string">"..." }
}

404Not found

json

{
  class="code-string">"error": {
    class="code-string">"code": class="code-string">"not_found",
    class="code-string">"message": class="code-string">"No audit found for slug 'unknown-com'."
  }
}

Scorecard Fields

Each entry in the scorecard array contains the following fields:

Name	Type	Required	Description
`id`	number	Required	Criterion ID (1-22)
`criterion`	string	Required	Criterion name
`score`	number	Required	Score 0-10
`status`	string	Required	"pass", "partial", or "fail"
`keyFindings`	string	Required	Summary of findings

Fix prompts are sorted by potential_gain (descending). Focus on the top 3 for the biggest score improvement.

Name

Type

Required

Description

slug

string

Required

Domain slug (e.g., "notion-com")

Name

Type

Required

Description

engine

string

Optional

Filter by engine. Without this param the response is an array of all engines. With this param it returns a single object.

include

string

Optional

Set to "fix_prompts" for actionable remediation advice

Code Examples

Basic:

bash

curl "https:">//www.aeocontent.ai/api/v1/audits/notion-com" \
  -H "Authorization: Bearer $AEO_API_KEY"

With fix prompts:

bash

curl "https:">//www.aeocontent.ai/api/v1/audits/notion-com?include=fix_prompts" \
  -H "Authorization: Bearer $AEO_API_KEY"

Response

Without the engine param, returns an array of all available engine audits. With ?engine=chatgpt, returns a single object.

200Audit data

json

{
  class="code-string">"data": [
    {
      class="code-string">"slug": class="code-string">"notion-com",
      class="code-string">"domain": class="code-string">"notion.com",
      class="code-string">"engine": class="code-string">"chatgpt",
      class="code-string">"overall_score": 62,
      class="code-string">"verdict": class="code-string">"Moderate AEO readiness with notable gaps in structured data.",
      class="code-string">"sector": class="code-string">"saas-productivity",
      class="code-string">"category": class="code-string">"Project Management",
      class="code-string">"scorecard": [
        {
          class="code-string">"id": 1,
          class="code-string">"criterion": class="code-string">"llms.txt",
          class="code-string">"score": 0,
          class="code-string">"status": class="code-string">"fail",
          class="code-string">"keyFindings": class="code-string">"No llms.txt file found at domain root."
        }
      ],
      class="code-string">"detailed_findings": [
        { class="code-string">"id": 1, class="code-string">"name": class="code-string">"llms.txt", class="code-string">"findings": [{ class="code-string">"description": class="code-string">"No /llms.txt file detected..." }] }
      ],
      class="code-string">"opportunities": [
        { class="code-string">"id": class="code-string">"opp-1", class="code-string">"name": class="code-string">"Add llms.txt", class="code-string">"description": class="code-string">"Create an llms.txt file...", class="code-string">"effort": class="code-string">"low", class="code-string">"impact": class="code-string">"high" }
      ],
      class="code-string">"bottom_line": class="code-string">"Notion has strong content but lacks AI-specific signals.",
      class="code-string">"pitch_numbers": null,
      class="code-string">"created_at": class="code-string">"2026-02-15T10:30:00.000Z"
    }
  ],
  class="code-string">"meta": { class="code-string">"request_id": class="code-string">"...", class="code-string">"timestamp": class="code-string">"..." }
}

When include=fix_prompts is set, two additional fields are appended to each audit object.

200With fix_prompts included

json

{
  class="code-string">"data": [
    {
      class="code-string">"...": class="code-string">"...audit fields above...",
      class="code-string">"fix_prompts": [
        {
          class="code-string">"criterion_id": 1,
          class="code-string">"criterion_name": class="code-string">"llms.txt",
          class="code-string">"category": class="code-string">"DISCOVERY",
          class="code-string">"current_score": 0,
          class="code-string">"potential_gain": 10,
          class="code-string">"prompt": class="code-string">"Create a /llms.txt file at your domain root...",
          class="code-string">"webflow_prompt": class="code-string">"In Webflow, create a static page..."
        }
      ],
      class="code-string">"fix_summary": {
        class="code-string">"criteria_to_fix": 8,
        class="code-string">"total_potential_gain": 23,
        class="code-string">"top_3_fixes": [
          class="code-string">"llms.txt (+10pts)",
          class="code-string">"Schema.org Markup (+8pts)",
          class="code-string">"FAQ Section (+5pts)"
        ]
      }
    }
  ],
  class="code-string">"meta": { class="code-string">"request_id": class="code-string">"...", class="code-string">"timestamp": class="code-string">"..." }
}

404Not found

json

{
  class="code-string">"error": {
    class="code-string">"code": class="code-string">"not_found",
    class="code-string">"message": class="code-string">"No audit found for slug 'unknown-com'."
  }
}

Name

Type

Required

Description

id

number

Required

Criterion ID (1-22)

criterion

string

Required

Criterion name

score

number

Required

Score 0-10

status

string

Required

"pass", "partial", or "fail"

keyFindings

string

Required

Summary of findings