Get agent score

Check how agent-ready a public documentation site is with the unauthenticated Mintlify agent score endpoint.

GET /agent/score

Get agent score

cURL

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

200

Example

{
  "canonicalUrl": "https://mintlify.com/docs",
  "score": 86,
  "status": "ready"
}

Use this endpoint to retrieve the agent score for any public documentation URL. The endpoint backs the free score tool and is open to anyone — no API key required.

When to use it

• Build a scorecard or badge into your own site.
• Monitor a docs site’s agent readiness in CI or a scheduled job.
• Compare scores across competitors or your own subdomains.

For interactive checks from your terminal, use the mint score command instead.

How it works

The first request for a URL queues a fresh score computation and returns 202 Accepted along with a Retry-After header. Subsequent requests return 200 OK with the latest computed score. Mintlify automatically refreshes stale scores in the background, so repeated polling against the same URL stays cheap.

Rate limits

• 10 requests per minute per IP address.

Example

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

A queued response while the score is being computed:

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

A ready response once the score is available:

{
  "canonicalUrl": "https://mintlify.com/docs",
  "score": 86,
  "status": "ready"
}

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

The public HTTPS URL of the documentation site to score. The host must be publicly resolvable. Maximum length is 2048 characters.

Maximum string length: 2048

Example:

"https://mintlify.com/docs"

Response

200

application/json

A score has been computed for the requested URL.

canonicalUrl · string<uri> · required

The canonical URL of the tracked site that Mintlify scored. This may differ from the requested URL if Mintlify resolved it to a different canonical form.

score · integer · required

Overall agent readiness score between 0 and 100.

Required range: 0 <= x <= 100

status · enum<string> · required

Indicates that a score is available in the response.

Available options: ready