About this endpoint
What it does
Scores how easily AI models and assistants can read, extract and cite a page: crawl access for AI bots, structural markup, content extractability and AI discoverability (llms.txt, structured data). Returns a score and recommendations.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The URL to analyze for AI readability |
Response
A JSON object; nested fields are written parent.child, and [] marks an array of objects.
| Field | Type | Description |
|---|---|---|
url | string | The URL that was checked, as you sent it. |
categories | object | Score per category; each has its checks. |
categories.structural_markup | object | Does markup describe the content: headings, semantic HTML, structured data. |
categories.structural_markup.max | integer | Most points this category can earn. |
categories.structural_markup.score | integer | Category score, 0–100. |
categories.structural_markup.checks | array of object | Individual checks behind this category's score. |
categories.structural_markup.checks[].name | string | Machine name of the check (e.g. title, meta_description, h1). |
categories.structural_markup.checks[].status | string | Result of the check — pass, warning, fail or info (informational, not scored). |
categories.structural_markup.checks[].score | integer | Points this check earned (0–100 for audit checks; out of max where max is given). |
categories.structural_markup.checks[].max | integer | Most points this check can earn. |
categories.structural_markup.checks[].detail | string | What the check found, in one line. |
categories.ai_discoverability | object | Can AI tools find and cite the page: metadata, canonical, sitemap, freshness. |
categories.ai_discoverability.max | integer | Most points this category can earn. |
categories.ai_discoverability.score | integer | Category score, 0–100. |
categories.ai_discoverability.checks | array of object | Individual checks behind this category's score. |
categories.ai_discoverability.checks[].name | string | Machine name of the check (e.g. title, meta_description, h1). |
categories.ai_discoverability.checks[].status | string | Result of the check — pass, warning, fail or info (informational, not scored). |
categories.ai_discoverability.checks[].score | integer | Points this check earned (0–100 for audit checks; out of max where max is given). |
categories.ai_discoverability.checks[].max | integer | Most points this check can earn. |
categories.ai_discoverability.checks[].detail | string | What the check found, in one line. |
categories.crawl_accessibility | object | Can AI crawlers fetch the page: server-rendered text, bot access, llms.txt, HTTPS, speed. |
categories.crawl_accessibility.max | integer | Most points this category can earn. |
categories.crawl_accessibility.score | integer | Category score, 0–100. |
categories.crawl_accessibility.checks | array of object | Individual checks behind this category's score. |
categories.crawl_accessibility.checks[].name | string | Machine name of the check (e.g. title, meta_description, h1). |
categories.crawl_accessibility.checks[].status | string | Result of the check — pass, warning, fail or info (informational, not scored). |
categories.crawl_accessibility.checks[].score | integer | Points this check earned (0–100 for audit checks; out of max where max is given). |
categories.crawl_accessibility.checks[].max | integer | Most points this check can earn. |
categories.crawl_accessibility.checks[].detail | string | What the check found, in one line. |
categories.content_extractability | object | Can the main content be pulled out cleanly: text structure, readability, lists and tables. |
categories.content_extractability.max | integer | Most points this category can earn. |
categories.content_extractability.score | integer | Category score, 0–100. |
categories.content_extractability.checks | array of object | Individual checks behind this category's score. |
categories.content_extractability.checks[].name | string | Machine name of the check (e.g. title, meta_description, h1). |
categories.content_extractability.checks[].status | string | Result of the check — pass, warning, fail or info (informational, not scored). |
categories.content_extractability.checks[].score | integer | Points this check earned (0–100 for audit checks; out of max where max is given). |
categories.content_extractability.checks[].max | integer | Most points this check can earn. |
categories.content_extractability.checks[].detail | string | What the check found, in one line. |
recommendations | array of object | Fix list, most important first. |
recommendations[].severity | string | How much fixing it matters — high, medium or low. |
recommendations[].issue | string | The problem found, in a short phrase. |
recommendations[].fix | string | The change to make. |
recommendations[].plain_english | string | Why it matters, in plain language for a non-specialist. |
recommendations[].who_fixes_it | string | Who usually makes the fix — e.g. content (copywriter/editor), developer, marketing. |
ai_readability_grade | string | AI readability letter grade, A+ to F. |
ai_readability_score | integer | AI readability score, 0–100. |