Scans

Get a scan

Returns the full scan including per-check results. Returns 404 if the scan does not exist or is not owned by the API key's user.

get/api/v1/scans/{id}

Request

  • Base URL: https://agent-ready.dev
  • URL: https://agent-ready.dev/api/v1/scans/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Scan id.

Response

Scan.

idstring required
rootUrlstring uri required
status'running' | 'completed' | 'failed' required

Lifecycle state of a scan. Poll until status is 'completed' or 'failed'.

createdAtstring date-time required
completedAtstring date-time nullable required
pagesDiscoveredinteger required
pagesScannedinteger required
vercelScoreinteger required
vercelRating'excellent' | 'good' | 'fair' | 'needs_improvement' required

Coarse rating bucket derived from the Vercel Agent Readability score.

llmstxtScoreinteger required
accessibilityScoreinteger nullable required

Accessibility / layout-stability sub-score over the homepage WCAG checks (A-series). Null when no accessibility checks ran. Separate from the Vercel score — accessibility is WCAG, not the Vercel Agent Readability Spec.

percentileinteger nullable required

Corpus percentile: share of scanned sites this score beats. Null when the corpus is too small to quote.

corpusTotalinteger nullable required

Number of sites the percentile is measured against. Null with percentile.

shareTokenstring required

Example response

{
  "id": "V1StGXR8_Z",
  "siteChecks": [
    {
      "checkId": "S1",
      "name": "llms.txt exists"
    }
  ],
  "llmstxtChecks": [
    {
      "checkId": "S1",
      "name": "llms.txt exists"
    }
  ],
  "pageResults": [
    {
      "checks": [
        {
          "checkId": "S1",
          "name": "llms.txt exists"
        }
      ]
    }
  ],
  "protocolResults": [
    {
      "checkId": "S1",
      "name": "llms.txt exists"
    }
  ]
}

Changes

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