Skip to content

Update from code changes: bring your own model settings - #7134

Open
mintlify[bot] wants to merge 9 commits into
mainfrom
mintlify/c5292809
Open

Update from code changes: bring your own model settings#7134
mintlify[bot] wants to merge 9 commits into
mainfrom
mintlify/c5292809

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new self-serve bring-your-own-key (BYOK) settings that let Enterprise deployments run Mintlify AI products on their own LLM provider and API key.

Changes

  • Added a "Bring your own model" section to the assistant configuration page covering the Enterprise add-on requirement, supported providers (OpenRouter, Anthropic, OpenAI-compatible), base URL requirements, model selection, and API key handling (secure storage, reuse, rotation, and removal).
  • Clarified that BYOK is a separately contracted Enterprise add-on and that the AI model section appears in the dashboard only when the add-on is included in the contract.
  • Noted that OpenRouter is the default provider and works with all Mintlify AI products, while Anthropic and OpenAI-compatible providers have limited compatibility.
  • Mirrored the new section in the Spanish, French, and Chinese translations.
  • Reverted unrelated accidental edits to the quickstart page that had landed on this branch (stray text in the description and a removed snippet import that broke the page).

Context

Enterprise customers can now configure the LLM that powers Mintlify AI products from the dashboard under Settings → API keys. The AI model section supports OpenRouter (default, full compatibility), Anthropic, and OpenAI-compatible providers with a curated model list per provider. API keys are stored securely, never shown after saving, and must be re-entered when provider settings change. The section is hidden entirely for deployments without the BYOK add-on.

https://github.com/mintlify/mint/pull/10437

Update history

  • Documented the initial self-serve BYOK settings UI (providers, models, key handling) with es/fr/zh translations (mint#10437).
  • Updated the plan-requirement wording: BYOK is a separately contracted Enterprise add-on and the AI model section is hidden without it, replacing the earlier "available on Enterprise plans" phrasing (mint#10517).
  • Documented OpenRouter as the default provider with full AI product compatibility and noted the limited compatibility of Anthropic and OpenAI-compatible providers, in all four languages; also reverted unrelated broken quickstart edits that had landed on this branch (mint#10538).

Note

Low Risk
Documentation-only changes to assistant configuration pages; no application code or security behavior changes.

Overview
Adds Bring your own model documentation to the assistant configuration guide (English plus es, fr, and zh), placed after bot protection and before billing.

The new section explains that BYOK is an Enterprise add-on: the AI model UI in Settings → API keys only appears when the add-on is on the contract. It walks through enabling Bring your own model, choosing OpenRouter (default, full product support), Anthropic, or OpenAI-compatible (limited compatibility), OpenAI-compatible HTTPS base URL rules, model selection, and secure API key storage, reuse on same-provider model changes, re-entry on provider/URL changes, rotation, and turning the toggle off to revert to Mintlify-managed models.

Frontmatter keywords are extended with BYOK-related terms in all four locales.

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

@mintlify

mintlify Bot commented Aug 26, 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 Aug 26, 2026, 8:20 PM

@mintlify

mintlify Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 26, 2026, 8:18 PM

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

@mintlify

mintlify Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Clarified BYOK as contracted Enterprise add-on hidden without entitlement

Source PRs

- Updated quickstart.mdx

Mintlify-Source: dashboard-editor
- Updated quickstart.mdx

Mintlify-Source: dashboard-editor
- Updated quickstart.mdx

Mintlify-Source: dashboard-editor

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 4fe8dfb. Configure here.

Comment thread quickstart.mdx Outdated
@mintlify

mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Added OpenRouter default and provider compatibility notes; reverted broken quickstart edits

Source PRs

  • mintlify/mint#10538 — chore: choose openrouter as the default and add warning about feature parity

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.

0 participants