Skip to content

Decouple search and assistant endpoints#6700

Merged
ethanpalm merged 4 commits into
mainfrom
docs/doc-385-move-search-endpoint
Jul 22, 2026
Merged

Decouple search and assistant endpoints#6700
ethanpalm merged 4 commits into
mainfrom
docs/doc-385-move-search-endpoint

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Documentation changes

Closes https://linear.app/mintlify/issue/DOC-385/move-search-endpoint-out-of-assistant-docs


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Documentation and OpenAPI description-only changes with no runtime or API behavior changes.

Overview
Splits search/page-content endpoints out of the Assistant section in docs.json into a dedicated Search nav group, leaving Assistant with only create-message. The API reference group icon changes from file-json to file-braces.

Updates api/introduction.mdx to treat assistant chat vs documentation retrieval as separate use cases, broaden assistant-key scope wording (messages, search, page content), and clarify billing: search and get-page-content do not consume credits; only assistant messages can incur overages. Security copy is tightened so credit-risk warnings focus on the message endpoint while still recommending proxying all assistant-key traffic.

OpenAPI (discovery-openapi.json) adds the no-credits note on search and page-content operations and corrects the get-page-content path parameter description to reference the search response’s path field (not page).

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

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 22, 2026, 10:34 PM

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

@mintlify

mintlify Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 22, 2026, 10:34 PM

@ethanpalm
ethanpalm merged commit 2536286 into main Jul 22, 2026
6 checks passed
@ethanpalm
ethanpalm deleted the docs/doc-385-move-search-endpoint branch July 22, 2026 22:38
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.

2 participants