Bring Your Own LLM Key
Breeze supports two ways to use your own LLM provider configuration:
- Hosted BYOK lets a partner use its own Anthropic API key for Breeze AI.
- Self-hosted instance configuration routes platform-keyed AI usage to an Anthropic-compatible or OpenAI-compatible endpoint.
If both are configured, a partner’s BYOK configuration takes precedence. Instance environment variables apply only to AI usage that would otherwise use the platform key.
Hosted: use your own Anthropic key
Section titled “Hosted: use your own Anthropic key”When you connect your own Anthropic API key, all AI features for your partner use that key and are billed directly to your Anthropic account. Breeze AI credits are not consumed.
Workspace content enrichment is currently an exception: it continues to use the Breeze platform key.
Requirements
Section titled “Requirements”You must be a partner admin with access to all organizations and the billing management permission. You must also complete MFA when you connect, replace, or disconnect a key.
Connect a key
Section titled “Connect a key”-
Open Partner Settings → AI Provider.
-
Paste your Anthropic API key into the write-only key field.
-
Optionally select a default model from the supported model list.
-
Click Save. Breeze verifies the key with Anthropic before storing it.
The page shows that your key is active and displays only its last four characters. Breeze never returns the full key after you save it.
To rotate the key, paste the replacement and save it. Breeze verifies the replacement before changing the stored key, so a failed verification leaves the existing working key in place.
To return to the Breeze platform key and Breeze AI credits, click Disconnect and complete MFA. Breeze does not switch back automatically.
Usage, budgets, and failures
Section titled “Usage, budgets, and failures”Organization AI budgets and rate limits still apply. With BYOK enabled, those controls limit usage billed to your own Anthropic account rather than consumption of Breeze AI credits.
While the partner key is active, the AI usage page shows the note “Billed to your key — AI usage goes to your own Anthropic account, not Breeze AI credits.”
Self-hosted: configure an instance-wide provider
Section titled “Self-hosted: configure an instance-wide provider”Self-hosted operators can configure an LLM backend for platform-keyed usage with environment variables. These settings apply across the instance, except for partners that have their own BYOK configuration.
Anthropic-compatible endpoint with tool calling
Section titled “Anthropic-compatible endpoint with tool calling”Use this path to route the full, tool-capable Breeze Agent through an endpoint that implements the Anthropic /v1/messages API, such as vLLM 0.23+ or LiteLLM.
| Variable | Required | Purpose |
|---|---|---|
ANTHROPIC_BASE_URL |
Yes | Base URL for the Anthropic-compatible endpoint. It must be a valid HTTP or HTTPS URL. |
ANTHROPIC_AUTH_TOKEN |
As required by the endpoint | Authentication token sent by the Anthropic SDK. |
ANTHROPIC_MODEL |
Optional | Overrides the default model ID, including for a raw vLLM model name or a LiteLLM alias. |
ANTHROPIC_BASE_URL is self-hosted only. Breeze refuses to start with this variable set unless IS_HOSTED is explicitly set to false (or another recognized false value). Hosted deployments cannot use a custom per-partner or instance-wide base URL.
OpenAI-compatible chat without tool calling
Section titled “OpenAI-compatible chat without tool calling”Use this path for a chat-only backend that implements the OpenAI API dialect. Tool calling is not supported on this path.
| Variable | Required | Purpose |
|---|---|---|
MCP_LLM_PROVIDER |
Yes | Set to openai-compatible. |
MCP_LLM_BASE_URL |
Yes | Base URL for the OpenAI-compatible endpoint. It must be a valid URL. |
MCP_LLM_MODEL |
Yes | Model ID exposed by the endpoint. |
MCP_LLM_API_KEY |
Yes | API key used to authenticate with the endpoint. |
MCP_LLM_PRICE_INPUT_PER_M_USD |
Optional | Input-token price in USD per million tokens. Defaults to 0. |
MCP_LLM_PRICE_OUTPUT_PER_M_USD |
Optional | Output-token price in USD per million tokens. Defaults to 0. |
The API validates the base URL and requires the model and API key when MCP_LLM_PROVIDER=openai-compatible. Both price values must be zero or greater.