docs: document public agent score API endpoint#5778
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Adds API reference documentation for the new unauthenticated public agent score endpoint, which returns the agent readiness score for any public documentation URL and powers the free score tool at mintlify.com/score.
Changes
score.openapi.json) describingGET /api/agent/scorewith thereadyandqueuedresponse shapes, query parameter validation, rate-limit and error responses.api/score/get-agent-score.mdxcovering when to use the endpoint, polling behavior, IP rate limits (10 req/min), and curl + response examples.docs.jsonand linked the new endpoint fromapi/introduction.mdx.gt.config.jsonso the page is translated alongside the other locales.Context
Source: mintlify/server#5211 introduced an unauthenticated, IP-rate-limited
GET /api/agent/score?url=...endpoint that returns a slim ready/queued response for clients polling while a score computes.Note
Low Risk
Low risk documentation/config-only change; main risk is incorrect OpenAPI/spec details or navigation wiring causing broken docs links/builds.
Overview
Documents a new public Agent Score API endpoint (
GET /agent/score) including polling semantics (202+Retry-Afterthen200) and example responses.Adds a new
score.openapi.jsonspec and registers it for localization/preview generation ingt.config.json, and links the new page fromapi/introduction.mdxplus a new Agent score section indocs.jsonnavigation.Reviewed by Cursor Bugbot for commit 8b058ce. Bugbot is set up for automated code reviews on this repo. Configure here.