Skip to content

docs: document public agent score API endpoint#5780

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/0a5c0c85
Open

docs: document public agent score API endpoint#5780
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/0a5c0c85

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 13, 2026

Summary

Documents the new public, unauthenticated GET /v1/score endpoint that returns an agent readiness score for any public documentation URL.

Changes

  • New API reference page api/agent/score.mdx covering when to use the endpoint, queued vs. ready responses, polling behavior, the 10 req/min per-IP rate limit, and a curl example.
  • New agent-score.openapi.json spec describing the request, queued/ready response shapes, and error codes (400, 429, 502).
  • Added the endpoint to the API reference navigation in docs.json and to the endpoint list in api/introduction.mdx.
  • Registered the new spec in gt.config.json and added matching locale entries/stubs for es, fr, and zh so translations pick it up on the next pass.

Context

Triggered by an upstream change that added a public URL-driven agent score endpoint with 10 req/min IP rate limiting. The endpoint returns queued while the analysis runs and ready (with the score plus AFDocs and Mintlify checks) once it completes.


Note

Low Risk
Low risk: documentation- and config-only changes (new MDX/OpenAPI files plus nav/i18n registration) with no runtime logic changes.

Overview
Documents a new public, unauthenticated GET /v1/score API, including polling semantics (202 queued with Retry-After vs 200 ready with score + checks), rate limits, and examples via a new api/agent/score.mdx page backed by agent-score.openapi.json.

Updates the API reference entry points (api/introduction.mdx and API navigation in docs.json plus es.json/fr.json/zh.json), and registers the new OpenAPI spec in gt.config.json with locale copies (es/, fr/, zh/).

Reviewed by Cursor Bugbot for commit c7b2e1c. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 13, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 13, 2026, 12:20 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant