-
Notifications
You must be signed in to change notification settings - Fork 10
BYOK rewrite + new Custom inference endpoint page + sidebar entry #71
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
41374c1
Rewrite BYOK page, add Custom inference endpoint page, and update sid…
hongyi-chen 3135686
Add BYOK / CIE org-size disclosure and soften CIE in-app search keyword
hongyi-chen ada7e27
docs(pricing-may-2026): weave platform credits into BYOK + CIE billin…
hongyi-chen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
...tent/docs/support-and-community/plans-and-billing/custom-inference-endpoint.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| --- | ||
| title: Custom inference endpoint | ||
| description: >- | ||
| Connect Warp to any OpenAI-compatible custom inference endpoint, such as | ||
| OpenRouter, LiteLLM, z.ai, or an internal gateway. Available on the Free | ||
| plan and all eligible paid plans. | ||
| --- | ||
|
|
||
| A **Custom inference endpoint (CIE)** lets you connect Warp's agents to any OpenAI-compatible inference endpoint, so you can route AI requests through your preferred model router, hosted gateway, or internal infrastructure. | ||
|
|
||
| CIE is the right fit when you want to choose your provider, consolidate billing through a third-party router, or run inference behind your own gateway — without giving up the agent experience inside Warp. When a CIE is configured and selected, Warp **never consumes your** [credits](/support-and-community/plans-and-billing/credits/) for the request. | ||
|
|
||
| :::note | ||
| CIE is available on the Free plan and on all eligible paid plans. See [warp.dev/pricing](https://www.warp.dev/pricing) for the current list of eligible plans. | ||
| ::: | ||
|
|
||
| ## Key features | ||
|
|
||
| * **OpenAI-compatible** - Works with any endpoint that implements the OpenAI Chat Completions API. | ||
| * **Provider flexibility** - Use a model router (OpenRouter, LiteLLM), a model provider with an OpenAI-compatible surface (z.ai), or your own internal gateway. | ||
| * **No Warp credits consumed** - Inference is billed directly by your endpoint provider; Warp's metered features remain unaffected. | ||
| * **Local configuration** - Endpoint URLs and credentials are stored locally on your device and never synced to the cloud. | ||
|
|
||
| ## How it works | ||
|
|
||
| CIE expects your endpoint to implement the **OpenAI Chat Completions API** (`POST /v1/chat/completions`). Any service that exposes a compatible surface can be used as a CIE target: | ||
|
|
||
| * **OpenRouter** - Aggregates many model providers behind a single OpenAI-compatible API and consolidated billing. | ||
| * **LiteLLM** - A self-hosted proxy that exposes a unified, OpenAI-compatible API across providers. | ||
| * **z.ai** - A model provider with an OpenAI-compatible API surface for its models. | ||
| * **Internal gateways** - Any in-house service that fronts model providers behind an OpenAI-compatible endpoint (for example, a corporate AI gateway with logging, redaction, or access control). | ||
|
|
||
| When you configure a CIE, Warp stores the endpoint URL, model identifiers, and credentials **locally on your device**. They are never synced to Warp's servers. | ||
|
|
||
| :::caution | ||
| CIE does not apply to [Oz Cloud Agents](/agent-platform/cloud-agents/overview/). Because CIE configuration is stored locally, it is not available to cloud-hosted agent runs. Cloud agent runs always consume [Warp credits](/support-and-community/plans-and-billing/credits/). | ||
| ::: | ||
|
|
||
| When a CIE-routed model is selected: | ||
|
|
||
| * Warp **does not consume** any of your [credits](/support-and-community/plans-and-billing/credits/). | ||
| * Costs are billed directly by your endpoint provider. | ||
| * Warp does not retain or store your endpoint credentials on any of its servers. | ||
|
|
||
| ## Enabling a custom inference endpoint | ||
|
|
||
| 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). | ||
| 3. Specify the model identifier(s) you want to route through this endpoint. | ||
| 4. Save the configuration. Once added, you'll see your custom models appear in the model picker. | ||
|
|
||
| When you explicitly select a CIE-routed model from the model picker, Warp routes the request through your endpoint instead of consuming Warp's credits. | ||
|
|
||
| The CIE configuration flow mirrors the [Bring your own API key](/support-and-community/plans-and-billing/bring-your-own-api-key/) setup, so the steps will feel familiar if you've already configured BYOK. | ||
|
|
||
| ## Billing behavior | ||
|
|
||
| ### Warp credits | ||
|
|
||
| When you select a CIE-routed model from the model picker: | ||
|
|
||
| * No Warp credits are consumed for that request. | ||
| * Inference is billed directly by your endpoint provider, according to their pricing. | ||
| * The credit transparency footer will show "0 credits used" for CIE-routed requests. | ||
|
|
||
| ### Auto routing still uses Warp credits | ||
|
|
||
| Warp's **Auto** models dynamically route across providers using Warp's infrastructure. Because Auto routing depends on Warp, **Auto always consumes Warp's credits**, even if you've configured a custom inference endpoint. | ||
|
|
||
| To use your endpoint, select the specific CIE-backed model from the model picker rather than an Auto option. | ||
|
|
||
| ### Other AI features in Warp | ||
|
|
||
| Some AI-powered features rely on Warp's infrastructure and are unaffected by CIE configuration. These continue to consume credits according to your plan; see [Credits](/support-and-community/plans-and-billing/credits/) for details. | ||
|
|
||
| ## Zero Data Retention (ZDR) | ||
|
|
||
| Warp is **SOC 2 compliant** and has **Zero Data Retention (ZDR)** agreements with all of its contracted LLM providers. | ||
|
|
||
| When you use a custom inference endpoint: | ||
|
|
||
| * Data retention is determined by **your endpoint provider** and any upstream model providers they route to. | ||
| * Warp **cannot enforce ZDR** for requests sent through a custom inference endpoint. | ||
| * If your endpoint provider does not have ZDR with the underlying model provider, your requests may be retained according to their terms. | ||
|
|
||
| Review your endpoint provider's data handling and retention policies before routing sensitive prompts through a CIE. | ||
|
|
||
| ## Plan availability | ||
|
|
||
| CIE is available on the Free plan and on all eligible paid plans. See [warp.dev/pricing](https://www.warp.dev/pricing) for the current list of eligible plans and any plan-specific limits. | ||
|
|
||
| Centrally configured, admin-managed CIE for teams is not yet available. Each user configures their own endpoint locally. Enterprise teams that need centrally managed model routing today should see [Bring your own LLM](/enterprise/enterprise-features/bring-your-own-llm/). | ||
|
|
||
| ## How CIE differs from BYOK and BYOLLM | ||
|
|
||
| Warp offers three ways to bring your own AI infrastructure. Use this table to pick the right one, and follow the links for full details. | ||
|
|
||
| | Name | Meaning | Plans | | ||
| | --- | --- | --- | | ||
| | **[Bring your own API key](/support-and-community/plans-and-billing/bring-your-own-api-key/)** (BYOK) | Use your own API key for OpenAI, Anthropic, or Google models. Keys are stored locally on your device. | Free and all eligible paid plans | | ||
| | **Custom inference endpoint** (CIE) | Connect Warp to an OpenAI-compatible endpoint such as OpenRouter, LiteLLM, z.ai, or an internal gateway. | Free and all eligible paid plans | | ||
| | **[Bring your own LLM](/enterprise/enterprise-features/bring-your-own-llm/)** (BYOLLM) | Enterprise-managed inference through your cloud provider (AWS Bedrock, Azure Foundry, Google Vertex) or approved internal infrastructure, with Warp handling routing, orchestration, governance, and observability. | Enterprise only | | ||
|
|
||
| ## Related resources | ||
|
|
||
| * [Bring your own API key](/support-and-community/plans-and-billing/bring-your-own-api-key/) — Use your own OpenAI, Anthropic, or Google API keys. | ||
| * [Bring your own LLM](/enterprise/enterprise-features/bring-your-own-llm/) — Enterprise-managed inference through your cloud provider or approved infrastructure. | ||
| * [Model Choice](/agent-platform/capabilities/model-choice/) — Full list of supported models and `model_id` values. | ||
| * [Credits](/support-and-community/plans-and-billing/credits/) — How Warp credits work and when they're consumed. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.