docs: document public agent score API endpoint#5780
Open
mintlify[bot] wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new public, unauthenticated
GET /v1/scoreendpoint that returns an agent readiness score for any public documentation URL.Changes
api/agent/score.mdxcovering when to use the endpoint, queued vs. ready responses, polling behavior, the 10 req/min per-IP rate limit, and acurlexample.agent-score.openapi.jsonspec describing the request, queued/ready response shapes, and error codes (400, 429, 502).docs.jsonand to the endpoint list inapi/introduction.mdx.gt.config.jsonand added matching locale entries/stubs fores,fr, andzhso 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
queuedwhile the analysis runs andready(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/scoreAPI, including polling semantics (202 queuedwithRetry-Aftervs200 readywith score + checks), rate limits, and examples via a newapi/agent/score.mdxpage backed byagent-score.openapi.json.Updates the API reference entry points (
api/introduction.mdxand API navigation indocs.jsonpluses.json/fr.json/zh.json), and registers the new OpenAPI spec ingt.config.jsonwith 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.