Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,25 +1,36 @@
---
title: Bring Your Own API Key
title: Bring your own API key
description: >-
Warp's paid plans include the ability to bring your own API keys (BYOK) for
OpenAI, Anthropic, and Google AI models.
Use your own OpenAI, Anthropic, or Google API keys with Warp's agents.
BYOK is available on the Free plan and all eligible paid plans, and never
consumes Warp credits.
---

Warp supports **Bring Your Own Key (BYOK)** for users who want to connect Warp’s agent to their own Anthropic, OpenAI, or Google API accounts.
Warp supports **Bring your own API key (BYOK)** for users who want to connect Warp's agents to their own Anthropic, OpenAI, or Google API accounts.

This lets you use your own API keys to access models directly, giving you full control over model selection, billing, and data routing. See [Model Choice](/agent-platform/capabilities/model-choice/) for a list of supported models.

BYOK provides greater flexibility in model access and ensures Warp **never consumes your** [credits](/support-and-community/plans-and-billing/credits/) for requests routed through your own keys.
BYOK gives you full control over model selection, billing, and data routing. See [Model Choice](/agent-platform/capabilities/model-choice/) for the full list of supported models. When you route a request through your own key, Warp **never consumes your** [credits](/support-and-community/plans-and-billing/credits/) for that request.

:::note
BYOK is currently only available on Warp's paid plans, starting with Build. Learn more about plans and pricing [warp.dev/pricing](https://www.warp.dev/pricing).
BYOK 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.
:::

## How does BYOK work?
## How BYOK differs from Custom inference endpoint 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** (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](/support-and-community/plans-and-billing/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 |

See [warp.dev/pricing](https://www.warp.dev/pricing) for current plan availability.

## How BYOK works

When you add your own model API keys in Warp, those keys are stored **locally on your device** and are **never synced to the cloud**.

Warp uses these API keys to directly route your agent requests to the model provider you've configured.
Warp uses these API keys to route your agent requests directly to the model provider you've configured.

:::caution
BYOK does not apply to [Oz Cloud Agents](/agent-platform/cloud-agents/overview/). Because your API keys are stored locally on your device, they are not available to cloud-hosted agent runs. Cloud agent runs always consume [Warp credits](/support-and-community/plans-and-billing/credits/).
Expand Down Expand Up @@ -53,9 +64,9 @@ When you explicitly select a model with a key icon, Warp routes requests through

### Auto Model

Warp's **Auto** models dynamically route requests across different models based on context and performance. Because this routing logic depends on Warps infrastructure, **Auto always consumes Warp's credits**, even if youve configured your own API keys.
Warp's **Auto** models dynamically route requests across different models based on context and performance. Because this routing logic depends on Warp's infrastructure, **Auto always consumes Warp's credits**, even if you've configured your own API keys.

To use your own key, select a specific provider model (for example, Claude Sonnet 4.5, GPT-5, or Gemini 2.5 Pro) directly from the model picker with a key icon.
To use your own key, select a specific provider model (for example, Claude Opus 4.7, Claude Sonnet 4.6, GPT-5.5, or Gemini 3.1 Pro) directly from the model picker with a key icon.

### Credit usage

Expand Down Expand Up @@ -93,7 +104,7 @@ If your key:

**Failover and fallback:**

By default, Warp does not fall back to your credits when a BYOK (Bring Your Own Key) request fails.
By default, Warp does not fall back to your credits when a BYOK request fails.

You can choose to enable **Warp credit fallback**. When enabled, if an agent request fails with your BYOK model (for example, due to an API error or quota limit), Warp will automatically route the request to one of Warp’s provided models. Warp always prioritizes your API keys first and only uses Warp credits when necessary.

Expand All @@ -113,10 +124,17 @@ Warp itself never stores your LLM API keys.

### BYOK on Enterprise and Business plans

Currently, BYOK is configured at the **user level**, not the team or admin level:
Today, BYOK is configured at the **user level** on every plan, including Enterprise and Business:

* Each team member can add and manage their own API keys locally on their device.
* Centrally configured, admin-managed BYOK is not yet available — admins cannot enforce or share API keys across team members from a single place.
* There is no organization-level Admin Panel for BYOK management today.

If your organization needs centrally managed model routing now, see [Bring your own LLM](/enterprise/enterprise-features/bring-your-own-llm/) for the Enterprise-managed option. To discuss a fit, contact us at [warp.dev/contact-sales](https://warp.dev/contact-sales).

* Each team member can add and manage their own API keys locally.
* Team admins cannot yet enforce or share API keys across members.
* There is currently no organization-level Admin Panel for BYOK management.
## Related resources

If your organization has specific needs for managed keys or enterprise-level control, please contact us at [warp.dev/contact-sales](https://warp.dev/contact-sales).
* [Custom inference endpoint](/support-and-community/plans-and-billing/custom-inference-endpoint/) — Route Warp through any OpenAI-compatible endpoint, such as OpenRouter, LiteLLM, z.ai, or an internal gateway.
* [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.
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).
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).

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.
1 change: 1 addition & 0 deletions src/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,7 @@ export const sidebarTopics: StarlightSidebarTopicsUserConfig = [
'support-and-community/plans-and-billing/credits',
'support-and-community/plans-and-billing/add-on-credits',
'support-and-community/plans-and-billing/bring-your-own-api-key',
'support-and-community/plans-and-billing/custom-inference-endpoint',
'support-and-community/plans-and-billing/overages-legacy',
'support-and-community/plans-and-billing/pricing-faqs',
],
Expand Down
Loading