Skip to content

Update from code changes: document universal search API#6581

Open
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/404ab3e4
Open

Update from code changes: document universal search API#6581
mintlify[bot] wants to merge 4 commits into
mainfrom
mintlify/404ab3e4

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new Universal Search REST API for customers with the Universal Search entitlement. Covers three endpoints: POST /universal-search/v1/search for querying Mintlify-hosted documentation and the wider web, POST /universal-search/v1/context for assembling a token-budgeted retrieval-augmented generation payload, and POST /universal-search/v1/contents for 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

  • Added api/universal-search/search.mdx, api/universal-search/context.mdx, and api/universal-search/contents.mdx API reference pages, with guidance on authentication, entitlement, request shape, partial-success behavior, and format selection.
  • Added universal-search-openapi.json describing all three endpoints, a shared result schema, request bodies, per-item error tags (not_found, not_synced, invalid_id, fetch_error), txt vs. json context formats, and example requests.
  • Updated api/introduction.mdx to list all three endpoints, add the universal search API key row, and describe when to use it.
  • Wired the new group and pages into the API reference navigation for English, Spanish, French, and Chinese, and added localized MDX pages and OpenAPI specs.
  • Registered the new OpenAPI file in gt.config.json.

Update history

  • Initial run: documented POST /universal-search/v1/search — new API reference page, OpenAPI spec, third API key type in api/introduction.mdx, navigation entries for en/es/fr/zh, localized page and spec copies, and gt.config.json registration. Documents https://github.com/mintlify/server/pull/6678.
  • Follow-up run: documented POST /universal-search/v1/contents — added api/universal-search/contents.mdx, extended universal-search-openapi.json with the new path and a shared Result schema, wired it into nav and api/introduction.mdx, and mirrored MDX, OpenAPI, and nav updates for es/fr/zh. Documents https://github.com/mintlify/server/pull/6677.
  • Follow-up run: documented POST /universal-search/v1/context — added api/universal-search/context.mdx covering the txt/json output formats, product retrieval bias, and 10,000-token budget; extended universal-search-openapi.json with the new path; wired it into nav and api/introduction.mdx; and mirrored MDX, OpenAPI, and nav updates for es/fr/zh. Documents https://github.com/mintlify/server/pull/6682.
  • Follow-up run: no docs change. The upstream commit (https://github.com/mintlify/server/pull/6731) adds an internal eval harness under 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.

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 15, 2026, 7:45 PM

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 15, 2026, 7:45 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 15, 2026, 7:41 PM

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 15, 2026, 7:41 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added Universal Search contents endpoint reference with translations

Source PRs

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added Universal Search context endpoint reference with translations

Source PRs

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added nothing; upstream change was internal tooling only

Source PRs

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