Skip to content

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

Closed
mintlify[bot] wants to merge 10 commits into
mainfrom
mintlify/c5292809
Closed

Update from code changes: bring your own model settings#7134
mintlify[bot] wants to merge 10 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 updates with no runtime, auth, or data-handling code changes.

Overview
Adds a Bring your own model section to the assistant configuration docs (English plus Spanish, French, and Chinese), placed after bot protection and before billing.

The new content documents the Enterprise add-on requirement, dashboard flow on API keys (AI modelBring your own model), supported providers (OpenRouter as default with full AI product support; Anthropic and OpenAI-compatible with limited compatibility), HTTPS base URL rules for OpenAI-compatible endpoints, secure API key storage/reuse/rotation, and disabling the toggle to remove BYOK config. Localized pages also gain BYOK-related keywords and anchor ids (bring-your-own-model).

Reviewed by Cursor Bugbot for commit 63b3565. 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

Comment thread assistant/configure.mdx Outdated
@ethanpalm

Copy link
Copy Markdown
Collaborator

Closing as superseded. This PR opened Aug 26; the dedicated Bring your own model page landed on main Aug 28 in #7174 (style pass in #7177). It's in the nav and linked from credits.mdx, and it covers this content more completely — credits at a reduced rate, per-deployment vs. org scope, the editor/admin role requirement, and provider coverage as a table.

The two details here that weren't already on that page — the HTTPS/publicly-reachable base URL constraint, and the AI model section being hidden without the add-on — are ported in #7197, along with a cross-link from assistant/configure.mdx, which had no path to the page.

Note for the next sync: BYOK config isn't assistant-specific (it covers the agent and automations too), so it belongs on /ai/bring-your-own-model rather than as a section on the assistant configuration page.

@ethanpalm ethanpalm closed this Aug 31, 2026
ethanpalm added a commit that referenced this pull request Aug 31, 2026
…link (#7197)

Ports two details from the superseded bot PR #7134 into the dedicated
bring your own model page:

- The OpenAI-compatible base URL must use HTTPS and point to a publicly
  reachable host.
- The AI model section only appears in the dashboard when the contract
  includes the add-on, so readers who can't find it know why.

Also adds a cross-link from the assistant configuration page, which had
no path to the bring your own model page. Placed in Manage billing next
to the existing credits link rather than as its own section, since the
configuration covers the agent and automations too, not just the
assistant.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
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