Skip to content

docs: custom routers now support BYOK (still no BYOE)#336

Open
hongyi-chen wants to merge 1 commit into
mainfrom
hongyi/custom-routers-byok
Open

docs: custom routers now support BYOK (still no BYOE)#336
hongyi-chen wants to merge 1 commit into
mainfrom
hongyi/custom-routers-byok

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Custom model routers now support BYOK: the server applies your provider API keys after a router resolves a task to a concrete model (warp-server #12382, released last week). Custom inference endpoints (BYOE) still can't be routing targets. This PR updates the docs, which previously said custom routers never draw on your own keys.

Behavior verified against warp-server (logic/ai/multi_agent/agents/primary/agent.go, logic/ai/multi_agent/request/model_config.go):

  • After task-time resolution, the resolved model uses your key when covered, so those requests bill through your provider and don't consume Warp credits.
  • Requests that resolve to a model without a matching key consume Warp credits as usual.
  • A router works with zero Warp credits only when your keys cover every model the router references.
  • Team-managed first-party keys (Enterprise) flow through the same path, with member keys taking precedence per provider.
  • Router targets must be Warp-supported models, so endpoint-routed models (self-serve or team) are still rejected — no BYOE.

Changes

  • custom-routers.mdx — Added a BYOK support bullet to Key features, and rewrote the credits section (now "Using your own API keys (BYOK)" + "Model availability and fallback"): per-request BYOK billing, the all-models-covered rule for running without Warp credits, team-managed keys, and that custom inference endpoints still can't be routing targets.
  • bring-your-own-api-key.mdx — Auto Model section: noted custom routers as the exception — keys are applied after the router resolves a model.
  • custom-inference-endpoint.mdx — Auto routing section: clarified routers never resolve to endpoint-routed models, while BYOK provider keys do apply.
  • team-managed-keys-and-endpoints.mdx (enterprise) — Billing behavior: custom routers route through team/member first-party keys after resolution; routers can't target team endpoint models.

Additional context

  • Requested by Suraj in Slack: "custom routers support byok now (still no byoe support)."
  • Validation: npm run build (347 pages), style lint on changed files (only pre-existing warnings on untouched lines), internal link check (0 broken).

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

Conversation: https://staging.warp.dev/conversation/ad441006-8c0c-4389-8500-450f6df36673
Run: https://oz.staging.warp.dev/runs/019f6bd3-b02d-7bfb-a87e-b7c7021e0cdc

This PR was generated with Oz.

Custom model routers now apply BYOK after task-time model resolution
(warp-server #12382). Update the custom routers page and related BYOK,
custom inference endpoint, and team-managed keys pages:

- Custom routers: BYOK key feature bullet; rewrite the credits section
  to explain per-request BYOK billing, the all-models-covered rule for
  running without Warp credits, team-managed keys, and that custom
  inference endpoints still can't be routing targets (no BYOE).
- BYOK page: note custom routers as the exception to Auto-model
  BYOK behavior.
- Custom inference endpoint page: clarify routers never resolve to
  endpoint-routed models.
- Team-managed keys page: routers route through team/member first-party
  keys after resolution.

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

vercel Bot commented Jul 16, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 16, 2026 5:01pm

Request Review

@cla-bot cla-bot Bot added the cla-signed label Jul 16, 2026
@hongyi-chen
hongyi-chen marked this pull request as ready for review July 16, 2026 17:03
@oz-for-oss

oz-for-oss Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

@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

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

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.

Overview

This PR updates the BYOK, custom router, custom inference endpoint, and Enterprise team-managed key documentation to reflect that custom routers can apply provider API keys after resolving to concrete Warp-supported models while still excluding custom inference endpoints. I found no blocking correctness, documentation-structure, link-target, security, or spec-alignment issues in the attached diff.

Concerns

  • None.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

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

Powered by Oz

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