Skip to content

BYOK rewrite + new Custom inference endpoint page + sidebar entry#71

Merged
hongyi-chen merged 3 commits into
hyc/plan-updatesfrom
hyc/plan-updates-byok-cie
May 19, 2026
Merged

BYOK rewrite + new Custom inference endpoint page + sidebar entry#71
hongyi-chen merged 3 commits into
hyc/plan-updatesfrom
hyc/plan-updates-byok-cie

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

Part of the May 2026 Warp pricing docs overhaul on hyc/plan-updates. Agent 2 of the four-agent fan-out: BYOK + new CIE page + sidebar.

Summary

  • Rewrite bring-your-own-api-key.mdx to open BYOK to the Free plan + all eligible paid plans (previously gated to paid plans starting with Build).
  • Create custom-inference-endpoint.mdx under support-and-community/plans-and-billing/ documenting Warp's new OpenAI-compatible Custom inference endpoint feature.
  • Update src/sidebar.ts to surface the new Custom inference endpoint page in the Plans and billing section, immediately after BYOK.

Why

The May 2026 launch introduces a new Custom inference endpoint (CIE) feature and opens BYOK up to Free. We need clean, side-by-side docs that disambiguate three ways to bring your own AI infrastructure:

  • BYOK — user-level API keys for OpenAI / Anthropic / Google (Free + paid)
  • CIE — any OpenAI-compatible endpoint such as OpenRouter, LiteLLM, z.ai, or an internal gateway (Free + paid)
  • BYOLLM — Enterprise-managed inference via Bedrock / Vertex / Foundry or approved internal infrastructure (Enterprise only)

Both pages include the same three-row comparison matrix so readers landing on either page can pick the right option.

BYOK page changes

  • Switched the eligibility callout from "paid plans, starting with Build" to "Free plan and all eligible paid plans."
  • Added a new top-level "How BYOK differs from Custom inference endpoint and BYOLLM" section with a Name / Meaning / Plans table.
  • Refreshed model examples (Claude Sonnet 4.5 / GPT-5 / Gemini 2.5 Pro → Claude Opus 4.7 / Claude Sonnet 4.6 / GPT-5.5 / Gemini 3.1 Pro) for parity with the Model Choice page.
  • Reframed the "BYOK on Enterprise and Business plans" subsection: BYOK is configured at the user level today, centrally configured admin-managed BYOK is not yet available, and Enterprise teams that need centrally managed routing should look at BYOLLM.
  • Added a "Related resources" section linking to CIE, BYOLLM, Model Choice, and Credits.
  • Switched the frontmatter title to sentence case ("Bring your own API key") for consistency with the BYOLLM page.

CIE page

New page built from the feature-doc template at .warp/templates/feature-doc.md (mirrored in .agents/templates/feature-doc.md). Sections:

  • Opening + plan-availability note
  • Key features
  • How it works (OpenAI Chat Completions requirement; OpenRouter / LiteLLM / z.ai / internal gateways as example targets)
  • Enabling a custom inference endpoint (Settings search flow; cross-link to BYOK setup)
  • Billing behavior (no Warp credits consumed; Auto still consumes credits; other Warp AI features unaffected)
  • Zero Data Retention (ZDR depends on endpoint provider; Warp cannot enforce)
  • Plan availability (Free + eligible paid plans; admin-managed CIE for teams not yet available)
  • How CIE differs from BYOK and BYOLLM (same comparison matrix)
  • Related resources

Editorial rule

Per the May 2026 plan, neither page hard-codes per-plan monthly credit counts. Both link to warp.dev/pricing for current allowances.

Files touched

  • src/content/docs/support-and-community/plans-and-billing/bring-your-own-api-key.mdx — rewrite
  • src/content/docs/support-and-community/plans-and-billing/custom-inference-endpoint.mdx — new
  • src/sidebar.ts — single-line addition after the BYOK entry (line ~504)

Coordination

  • Targets the umbrella branch hyc/plan-updates, not main.
  • Only this agent (Agent 2) touches src/sidebar.ts per the orchestration plan.
  • No collisions with Agents 1, 3, or 4: this PR does not touch pricing-faqs.mdx, add-on-credits.mdx, credits.mdx, bring-your-own-llm.mdx, plans-pricing-refunds.mdx, enterprise/support-and-resources/billing.mdx, or plans-and-billing/index.mdx.

Conversation

Drafted via Warp: https://staging.warp.dev/conversation/8f67eb03-74a7-4efe-9d60-7cd2ea7af40f

Co-Authored-By: Oz oz-agent@warp.dev

…ebar

Open BYOK to Free + all eligible paid plans (previously gated to paid plans
starting with Build). Reframe BYOK alongside two adjacent options:

- Add a 'How BYOK differs from Custom inference endpoint and BYOLLM'
  comparison section with a three-row matrix (Name / Meaning / Plans) on
  the BYOK page.
- Refresh BYOK model examples to current frontier (Claude Opus 4.7,
  Claude Sonnet 4.6, GPT-5.5, Gemini 3.1 Pro) for parity with
  the Model Choice page.
- Clarify that centrally configured, admin-managed BYOK is not yet
  available; keep the user-level configuration story.
- Add a Related resources section linking to the new CIE page, BYOLLM,
  Model Choice, and Credits.

Add a new Custom inference endpoint page under plans-and-billing/ using
the feature-doc structure. Covers what CIE is, the OpenAI-compatible
Chat Completions API requirement, example endpoints (OpenRouter,
LiteLLM, z.ai, internal gateways), enablement steps, billing behavior
(no Warp credits consumed; Auto still uses credits), ZDR caveats (depend
on endpoint provider), Free + eligible paid plan availability, the same
three-row comparison matrix, and Related resources.

Per the May 2026 editorial rule, neither page hard-codes per-plan
monthly credit counts; both link to warp.dev/pricing.

Insert the CIE page slug into the Plans and billing sidebar section
immediately after BYOK.

Part of the May 2026 pricing docs overhaul on hyc/plan-updates.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 13, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 19, 2026 11:21pm

Request Review

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented May 13, 2026

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

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

Overview

This PR updates the BYOK documentation for the new plan availability, adds a new Custom inference endpoint page, and exposes that page in the billing sidebar. The changed links and sidebar entry are scoped to the documented pages, and the content generally matches the intended BYOK/CIE/BYOLLM separation.

Concerns

  • Add HTTPS guidance for remote Custom inference endpoint URLs so users do not accidentally send prompts or endpoint credentials over plaintext transport.

Security

  • The only security finding is documentation guidance: the CIE setup flow should call out HTTPS for remote endpoints because those endpoints receive sensitive prompts and credentials.

Verdict

Found: 0 critical, 0 important, 1 suggestions

Approve with nits

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

To enable and configure a custom inference endpoint:

1. In Warp, open **Settings** and search for `custom inference endpoint` to jump to the configuration.
2. Add your endpoint URL (the base URL that exposes `/v1/chat/completions`) and any required credentials (typically an API key).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 [SUGGESTION] [SECURITY] Clarify that remote custom endpoints should use HTTPS so users do not send endpoint credentials or prompts over plaintext transport.

Suggested change
2. Add your endpoint URL (the base URL that exposes `/v1/chat/completions`) and any required credentials (typically an API key).
2. Add your endpoint URL (the base URL that exposes `/v1/chat/completions`; use HTTPS for remote endpoints) and any required credentials (typically an API key).

Per follow-up review on PR #71:

- Add a second top-of-page :::note callout on both bring-your-own-api-key.mdx
  and custom-inference-endpoint.mdx clarifying that BYOK and CIE are
  available to individual users and organizations with 10 or fewer
  employees; larger organizations need a Warp Business or Enterprise plan.
- Mirror the same disclosure as a one-sentence statement near the bottom
  of each page so readers who jump to the BYOK Enterprise/Business section
  (BYOK) or the Plan availability section (CIE) see the restriction inline.
- Soften the CIE 'Enabling' step from 'search for custom inference endpoint'
  to 'search for inference endpoint' since the exact configuration name
  was not verifiable.

Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen added a commit that referenced this pull request May 13, 2026
This file is the canonical version created on PR #71
(hyc/plan-updates-byok-cie). It is duplicated here so that the
link checker on this branch can resolve the relative references
to /support-and-community/plans-and-billing/custom-inference-endpoint/
that this PR introduces.

When PR #71 merges into hyc/plan-updates, git will reconcile the
identical file contents automatically.

Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen added a commit that referenced this pull request May 13, 2026
This file is the canonical version created on PR #71
(hyc/plan-updates-byok-cie). It is duplicated here so that the
link checker on this branch can resolve the relative references
to /support-and-community/plans-and-billing/custom-inference-endpoint/
that this PR introduces.

When PR #71 merges into hyc/plan-updates, git will reconcile the
identical file contents automatically.

Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen added a commit that referenced this pull request May 19, 2026
…account FAQ, new platform-credits FAQ

Adds platform-credits caveats to the BYOK, custom inference endpoint, and "What if I need more AI usage" FAQs so Business/Enterprise readers know local agent runs that use customer-supplied inference still consume platform credits.

Expands the service-account / team-scoped API key FAQ to introduce the task billing principal concept, spell out the owner-pool waterfall, describe auto-reload off vs on behavior, and clarify that attribution stays on the service account while billing rolls up to the team owner. Expands the Enterprise note in that FAQ to cover team-scoped credit pool depletion and the PAYG fallback.

Adds a new "How do platform credits factor in?" FAQ after the multi-seat credits FAQ, summarizing the three credit buckets (AI, compute, platform) and when platform credits apply.

Pre-existing build error (CIE page missing from sidebar topic) is unrelated to this change and is fixed by PR #71's src/sidebar.ts update once it merges into the umbrella.

Co-Authored-By: Oz <oz-agent@warp.dev>
…g copy

Soften the "never consumes Warp credits" claims on the BYOK and Custom inference
endpoint (CIE) pages so they accurately reflect the May 2026 launch: on Business
and Enterprise, local agent runs that use customer-supplied inference still
consume platform credits for Warp's platform infrastructure (run lifecycle,
integrations, observability).

Changes on each page:
- Trim the frontmatter description to mention the Business/Enterprise platform
  credits caveat for local runs (keeping length around the 160-char target).
- Add a :::note callout right after the "never consumes your credits" paragraph
  pointing readers at the platform credits doc.
- Add a footnote line under the BYOK / CIE / BYOLLM comparison table noting
  that platform credits may apply for local agent runs on Business and
  Enterprise across all three customer-supplied inference paths.

Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen added a commit that referenced this pull request May 19, 2026
…in plan summary, Enterprise billing

- bring-your-own-llm.mdx: rewrite Cloud-native credentials bullet so it covers
  AWS IAM (GA) plus Google Cloud and Azure identities (roadmap); add a
  platform-credits note next to the BYOLLM 'no Warp credits consumed' framing
  so Enterprise readers know local agent runs still consume platform credits;
  add the platform-credits page to Related resources.
- plans-pricing-refunds.mdx: append a one-liner about platform credits to the
  Business and Enterprise bullets of the May 2026 plan summary so readers
  understand when platform credits apply across customer-supplied inference.
- enterprise/support-and-resources/billing.mdx: add the platform-credits page
  to Related resources alongside Add-on Credits and Credits.

Pre-existing build/link-check failures (CIE sidebar registration; platform-credits.mdx not yet on the umbrella) are out of scope here and will be resolved by PR #71's sidebar.ts update and the umbrella rebase onto main.

Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen added a commit that referenced this pull request May 19, 2026
…-endpoint.mdx

The CIE page is owned by PR #71 (hyc/plan-updates-byok-cie), which also
adds the matching src/sidebar.ts entry. Removing the stub here so the
PR #72 \u2192 umbrella merge auto-resolves cleanly after #71 lands.

Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen added a commit that referenced this pull request May 19, 2026
…-endpoint.mdx

The CIE page is owned by PR #71 (hyc/plan-updates-byok-cie), which also
adds the matching src/sidebar.ts entry. Removing the stub here so the
PR #73 \u2192 umbrella merge auto-resolves cleanly after #71 lands.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen hongyi-chen merged commit d3f0b70 into hyc/plan-updates May 19, 2026
3 of 4 checks passed
@hongyi-chen hongyi-chen deleted the hyc/plan-updates-byok-cie branch May 19, 2026 23:36
hongyi-chen added a commit that referenced this pull request May 19, 2026
…ing, and plans-and-billing index (#72)

* docs: update BYOLLM, plan summary, Enterprise billing, and plans-and-billing index for May 2026

- bring-your-own-llm.mdx: Reframe as Enterprise-only managed inference (Bedrock GA, Vertex/Foundry roadmap, internal gateways). Add a comparison section that contrasts BYOLLM with BYOK and Custom inference endpoint, with a note that centrally configured BYOK/CIE for Enterprise is a fast-follow after launch.

- plans-pricing-refunds.mdx: Add May 2026 plan summary (Free, Build, Max, Business, Enterprise) with seat limits and qualitative descriptions of each plan's value. Link out to warp.dev/pricing for current monthly credit allowances instead of hard-coding numbers. Add a Custom inference endpoint bullet to the existing sub-page list.

- enterprise/support-and-resources/billing.mdx: Clarify that team-wide spend limits are also available on self-serve paid plans while per-user spend limits are Enterprise-only. Add a related-resources link to the Enterprise Analytics API.

- plans-and-billing/index.mdx: Add a Custom inference endpoint bullet so the new page is discoverable from the plans-and-billing landing page.

Part of the May 2026 Warp pricing docs overhaul (hyc/plan-updates).

Co-Authored-By: Oz <oz-agent@warp.dev>

* docs(pricing-may-2026): correct plan seat limits per orchestrator

Update May 2026 plan summary in plans-pricing-refunds.mdx with the actual seat limits from the pricing-context dump:

- Free / Build / Max: Up to 10 team members

- Business: Up to 25 team members

- Enterprise: Unlimited team members (custom contract)

Also reframe descriptions so 'individual' language is dropped from plans that support up to 10 team members.

Co-Authored-By: Oz <oz-agent@warp.dev>

* docs(pricing-may-2026): add BYOK / CIE org-size disclosure (10 or fewer employees)

Per user requirement: BYOK and custom inference endpoint are limited to individual users and orgs with 10 or fewer employees on Free / Build / Max; larger orgs require a Business or Enterprise plan.

- bring-your-own-llm.mdx: Update the BYOK and CIE rows in the comparison matrix to reflect the org-size constraint, add a :::note disclosure callout immediately below the matrix, and rephrase the corresponding FAQ for consistency.

- plans-pricing-refunds.mdx: Add the same :::note disclosure callout after the May 2026 plan summary bullet list, before the ZDR sentence (one callout covering the Free / Build / Max bullets).

Co-Authored-By: Oz <oz-agent@warp.dev>

* Add Custom inference endpoint page stub for CI link check

This file is the canonical version created on PR #71
(hyc/plan-updates-byok-cie). It is duplicated here so that the
link checker on this branch can resolve the relative references
to /support-and-community/plans-and-billing/custom-inference-endpoint/
that this PR introduces.

When PR #71 merges into hyc/plan-updates, git will reconcile the
identical file contents automatically.

Co-Authored-By: Oz <oz-agent@warp.dev>

* docs(pricing-may-2026): BYOLLM cross-provider IAM + platform credits in plan summary, Enterprise billing

- bring-your-own-llm.mdx: rewrite Cloud-native credentials bullet so it covers
  AWS IAM (GA) plus Google Cloud and Azure identities (roadmap); add a
  platform-credits note next to the BYOLLM 'no Warp credits consumed' framing
  so Enterprise readers know local agent runs still consume platform credits;
  add the platform-credits page to Related resources.
- plans-pricing-refunds.mdx: append a one-liner about platform credits to the
  Business and Enterprise bullets of the May 2026 plan summary so readers
  understand when platform credits apply across customer-supplied inference.
- enterprise/support-and-resources/billing.mdx: add the platform-credits page
  to Related resources alongside Add-on Credits and Credits.

Pre-existing build/link-check failures (CIE sidebar registration; platform-credits.mdx not yet on the umbrella) are out of scope here and will be resolved by PR #71's sidebar.ts update and the umbrella rebase onto main.

Co-Authored-By: Oz <oz-agent@warp.dev>

* Remove duplicate CIE stub; PR #71 owns the canonical custom-inference-endpoint.mdx

The CIE page is owned by PR #71 (hyc/plan-updates-byok-cie), which also
adds the matching src/sidebar.ts entry. Removing the stub here so the
PR #72 \u2192 umbrella merge auto-resolves cleanly after #71 lands.

Co-Authored-By: Oz <oz-agent@warp.dev>

---------

Co-authored-by: Oz <oz-agent@warp.dev>
hongyi-chen added a commit that referenced this pull request May 19, 2026
* Overhaul pricing FAQs for May 14, 2026 pricing changes

* Delete the entire 'Warp's pricing change FAQs (Oct 30, 2025)' section
  and remove the stale anchor link from the 'How can I get the most out
  of my Warp plan?' callout.
* Rewrite plan-recommendation copy with qualitative Build / Max /
  Business / Enterprise positioning; replace 'enforced team-wide ZDR'
  language with 'admin-configurable data controls' and split model-
  provider ZDR out as a separate, all-plan concept.
* Update the Lite-model FAQ to mention BYOK and Custom Inference
  Endpoint (CIE) alongside Reload credits.
* Add new FAQs: multi-seat team credits with grandfathered pooled
  credits, what-to-do-when-you-need-more-AI-usage (Max + Reload + BYOK +
  CIE), how auto-reload works for teams, and how service-account /
  team-scoped API key requests are billed on self-serve plans.
* Add BYOK-on-all-plans and CIE FAQs; rename 'Add-on Credits' to
  'Reload credits' and fix one remaining stale anchor link inside the
  downgrade caution callout.
* Add new tail-end 'Warp's pricing change FAQs (May 14, 2026)' section
  covering seat limits + grandfathering, Reload credits attribution
  change, Max plan credit-allocation change + grandfathering, BYOK on
  Free, the CIE launch, and the ZDR / data-controls clarification.

Per the editorial rule, no per-plan monthly credit counts are
hard-coded; the page links to warp.dev/pricing for current allowances.

Co-Authored-By: Oz <oz-agent@warp.dev>

* Add BYOK / CIE org-size disclosure to pricing FAQs

Per PR #73 follow-up: BYOK and custom inference endpoint support are
available to individual users and organizations with 10 or fewer
employees; larger organizations need a Business or Enterprise plan.

* 'Can I bring my own API key?' FAQ: append the verbatim disclosure
  paragraph at the end of the answer.
* 'Does Warp support custom inference endpoints?' FAQ: same.
* 'What if I need more AI usage than my plan includes?' FAQ: add a
  one-line italicized cross-reference below the BYOK / CIE bullets
  pointing to the BYOK FAQ above.

Co-Authored-By: Oz <oz-agent@warp.dev>

* Add Custom inference endpoint page stub for CI link check

This file is the canonical version created on PR #71
(hyc/plan-updates-byok-cie). It is duplicated here so that the
link checker on this branch can resolve the relative references
to /support-and-community/plans-and-billing/custom-inference-endpoint/
that this PR introduces.

When PR #71 merges into hyc/plan-updates, git will reconcile the
identical file contents automatically.

Co-Authored-By: Oz <oz-agent@warp.dev>

* docs(pricing-may-2026): add platform-credits caveats, expand service-account FAQ, new platform-credits FAQ

Adds platform-credits caveats to the BYOK, custom inference endpoint, and "What if I need more AI usage" FAQs so Business/Enterprise readers know local agent runs that use customer-supplied inference still consume platform credits.

Expands the service-account / team-scoped API key FAQ to introduce the task billing principal concept, spell out the owner-pool waterfall, describe auto-reload off vs on behavior, and clarify that attribution stays on the service account while billing rolls up to the team owner. Expands the Enterprise note in that FAQ to cover team-scoped credit pool depletion and the PAYG fallback.

Adds a new "How do platform credits factor in?" FAQ after the multi-seat credits FAQ, summarizing the three credit buckets (AI, compute, platform) and when platform credits apply.

Pre-existing build error (CIE page missing from sidebar topic) is unrelated to this change and is fixed by PR #71's src/sidebar.ts update once it merges into the umbrella.

Co-Authored-By: Oz <oz-agent@warp.dev>

* Remove duplicate CIE stub; PR #71 owns the canonical custom-inference-endpoint.mdx

The CIE page is owned by PR #71 (hyc/plan-updates-byok-cie), which also
adds the matching src/sidebar.ts entry. Removing the stub here so the
PR #73 \u2192 umbrella merge auto-resolves cleanly after #71 lands.

Co-Authored-By: Oz <oz-agent@warp.dev>

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant