Get agent score

Check how well any public documentation site is structured for AI agents with a single unauthenticated request.

GET /v1/score

Get agent score

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/score \
  --header 'Authorization: Bearer <token>'

200

{
  "canonicalUrl": "<string>",
  "score": 50,
  "checks": [
    {
      "id": "<string>",
      "name": "<string>",
      "message": "<string>",
      "category": "<string>",
      "children": "<array>"
    }
  ]
}

Use this endpoint to fetch the agent readiness score for any public documentation URL. It powers the mint score CLI command and the public AgentRank leaderboard, and you can call it directly from your own tools, CI checks, or dashboards.

The endpoint is unauthenticated — no API key is required.

Call it at GET https://api.mintlify.com/v1/score with the public documentation URL in the url query parameter.

When to use it

• Show an agent readiness badge or score on a status page.
• Add a quality gate to CI that fails when a docs site falls below a target score.
• Build a custom report or comparison across multiple documentation sites.

If you only need to check your own site interactively, run mint score instead.

How it works

The first request for a URL Mintlify has not analyzed before returns 202 Accepted with status: "queued" and a Retry-After header. Mintlify analyzes the site in the background, then subsequent requests return 200 OK with status: "ready" and the full list of checks.

Cached scores are returned immediately. If a cached score is older than one hour, Mintlify queues a background refresh but still returns the cached result so your application is not blocked.

Rate limits

• 10 requests per minute, per IP address.

Requests beyond the limit receive 429 Too Many Requests.

Example

Poll until the score is ready:

curl "https://api.mintlify.com/v1/score?url=https://mintlify.com/docs"

A queued response looks like:

{
  "status": "queued",
  "canonicalUrl": "https://mintlify.com/docs",
  "retryAfterSeconds": 10
}

A ready response looks like:

{
  "status": "ready",
  "canonicalUrl": "https://mintlify.com/docs",
  "score": 92,
  "checks": [
    {
      "id": "llms-txt",
      "name": "llms-txt",
      "status": "pass",
      "category": "discovery"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

url · string<uri> · required

Public HTTPS URL of the documentation site to score. URLs without a scheme are upgraded to https://. Maximum length is 2048 characters.

Maximum string length: 2048

Example:

"https://mintlify.com/docs"

Response

200

application/json

The score is ready.

status · enum<string> · required

Indicates that the score is available.

Available options: ready

canonicalUrl · string<uri> · required

The canonical URL Mintlify resolved from the requested URL.

score · integer · required

Overall agent readiness score for the site, from 0 to 100.

Required range: 0 <= x <= 100

checks · object[] · required

Individual check results from the AgentRank (AFDocs) framework and Mintlify-specific checks.

Show child attributes