Update from code changes: document universal search API#6581
Open
mintlify[bot] wants to merge 4 commits into
Open
Update from code changes: document universal search API#6581mintlify[bot] wants to merge 4 commits into
mintlify[bot] wants to merge 4 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Update from code changes updated this PR. Added Universal Search contents endpoint reference with translations Source PRs
|
Contributor
Author
|
Update from code changes updated this PR. Added Universal Search context endpoint reference with translations Source PRs
|
Contributor
Author
|
Update from code changes updated this PR. Added nothing; upstream change was internal tooling only Source PRs |
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 Universal Search REST API for customers with the Universal Search entitlement. Covers three endpoints:
POST /universal-search/v1/searchfor querying Mintlify-hosted documentation and the wider web,POST /universal-search/v1/contextfor assembling a token-budgeted retrieval-augmented generation payload, andPOST /universal-search/v1/contentsfor fetching stitched Markdown for specific pages by ID or URL with per-input success or error statuses. Related upstream changes: https://github.com/mintlify/server/pull/6678, https://github.com/mintlify/server/pull/6682, and https://github.com/mintlify/server/pull/6677.Changes
api/universal-search/search.mdx,api/universal-search/context.mdx, andapi/universal-search/contents.mdxAPI reference pages, with guidance on authentication, entitlement, request shape, partial-success behavior, and format selection.universal-search-openapi.jsondescribing all three endpoints, a shared result schema, request bodies, per-item error tags (not_found,not_synced,invalid_id,fetch_error),txtvs.jsoncontext formats, and example requests.api/introduction.mdxto list all three endpoints, add the universal search API key row, and describe when to use it.gt.config.json.Update history
POST /universal-search/v1/search— new API reference page, OpenAPI spec, third API key type inapi/introduction.mdx, navigation entries for en/es/fr/zh, localized page and spec copies, andgt.config.jsonregistration. Documents https://github.com/mintlify/server/pull/6678.POST /universal-search/v1/contents— addedapi/universal-search/contents.mdx, extendeduniversal-search-openapi.jsonwith the new path and a sharedResultschema, wired it into nav andapi/introduction.mdx, and mirrored MDX, OpenAPI, and nav updates for es/fr/zh. Documents https://github.com/mintlify/server/pull/6677.POST /universal-search/v1/context— addedapi/universal-search/context.mdxcovering thetxt/jsonoutput formats,productretrieval bias, and 10,000-token budget; extendeduniversal-search-openapi.jsonwith the new path; wired it into nav andapi/introduction.mdx; and mirrored MDX, OpenAPI, and nav updates for es/fr/zh. Documents https://github.com/mintlify/server/pull/6682.evals/universal-search/for measuring Universal Search quality against historical ClickHouse queries. It has no customer-facing API, entitlement, or behavior change, so nothing was added to the docs.