Skip to content

Add BYOK base URL constraint, add-on visibility, and assistant cross-link - #7197

Merged
ethanpalm merged 1 commit into
mainfrom
byok-page-crosslink-and-details
Aug 31, 2026
Merged

ethanpalm merged 1 commit into
mainfrom
byok-page-crosslink-and-details

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

What changed

  • ai/bring-your-own-model.mdx: noted that the OpenAI-compatible base URL must use HTTPS and point to a publicly reachable host, and that the AI model section only appears in the dashboard when the contract includes the add-on.
  • assistant/configure.mdx: added a cross-link to /ai/bring-your-own-model in Manage billing.

Rationale

Bot PR #7134 predates the dedicated bring your own model page (#7174, #7177) and duplicates it. These are the only two facts in that PR not already covered by the merged page. #7134 is being closed in favor of this.

The assistant configuration page had no link to the bring your own model page at all. The link goes in Manage billing, next to the existing /credits link, rather than in its own section: the configuration covers the agent and automations too, so a ## Bring your own model heading on an assistant page would overstate its scope, and someone reading about credit consumption is the reader who wants to know about the reduced rate.

Alternatives considered

Merging #7134 as-is, or trimming it to a link. Both leave a bot branch that reintroduces duplicate content on the next sync. Closing it and porting the deltas here is cleaner.

Areas of uncertainty

  • The "publicly reachable host" constraint comes from the bot PR's reading of mint#10538, not from reading the validation code. Worth a check against the actual base URL validation before merge.
  • English only. Translations follow automatically after merge.

Checks

mint broken-links passes, mint a11y passes, vale reports 0 errors on both files (2 pre-existing passive-voice suggestions on untouched lines).

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only edits with no runtime, auth, or data-handling impact.

Overview
Updates bring your own model docs with two configuration clarifications and ties the assistant billing page to that guide.

On ai/bring-your-own-model.mdx, the Enterprise callout now states that the dashboard AI model section only shows when the contract includes the add-on. Step 4 for OpenAI-compatible providers now requires the base URL to use HTTPS and target a publicly reachable host.

On assistant/configure.mdx, Manage billing adds a short Enterprise note linking to /ai/bring-your-own-model for using your own provider/API key at a reduced credit rate, alongside the existing credits pricing link.

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

…link

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>
@mintlify

mintlify Bot commented Aug 31, 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 Aug 31, 2026, 5:05 PM

@mintlify

mintlify Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 31, 2026, 5:04 PM

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

@ethanpalm
ethanpalm merged commit 0d8e3f5 into main Aug 31, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the byok-page-crosslink-and-details branch August 31, 2026 17:07
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