Available on the Enterprise plan.
Supported providers
Configuration
Step 1: Add a model
Before assigning a BYOM model to an agent, you need to register it in the admin panel:- Navigate to Admin > Models
- Click Add model
- Provide a name for the model
- Select the model type (LLM or Embedding)
- Choose a provider and model
- Optionally, pick a small model
- Enter the required credentials for the provider
Step 2: Assign the model to an agent
Once a model is registered, reference it in the agents YAML configuration by name or ID:Small model
The agent runs short tasks, such as suggested questions and memory, on a small model. For an LLM on Anthropic, AWS Bedrock, GCP Vertex AI or OpenAI, pick it in the Small model field under Model; other providers run these tasks on the main model. The small model uses the same provider, region and credentials as the main model.
If your account cannot use the small model (for example, it is not enabled in
your region), the agent runs these tasks on the main model instead.
On AWS Bedrock, the inference profile applies to the main model only; the
small model is called on demand in the configured region.
Network configuration
If your provider requires IP allowlisting, allowlist the Cube egress IP addresses. Agents that run in the control plane call your provider from the control-plane addresses; agents that run in a single-tenant or BYOC region call it from that region’s own egress IPs.Billing
When using a BYOM model, Cube AI tokens are not consumed. You are billed directly by your model provider based on their pricing. This means:- No Cube token quota is deducted for BYOM chat requests
- Administrators can see BYOM requests with their token counts, at no cost, in the AI Tokens Usage tab, and they’re recorded in the AI Calls & Cost view in Usage Analytics
- Per-seat token grants and token packages do not apply
Provider-specific notes
Extended thinking
Anthropic, AWS Bedrock, and GCP Vertex AI support extended thinking for Claude Sonnet 3.7 and all later Claude models. Turn it on or off with the Enable thinking toggle in the model settings. The toggle is on by default when you add a model.Anthropic
Requires an API key.AWS Bedrock
- Credentials are optional — if left empty, the default AWS credential chain is used (e.g., workload identity)
- Supports assume-role configuration for cross-account access
- Supports inference profiles
GCP Vertex AI
Requires a service account JSON key for authentication.Databricks
Requires a workspace URL and access token.Snowflake Cortex
Supports two authentication methods:- JWT authentication
- Key-pair authentication (requires an encrypted PKCS#8 PEM private key)
Custom OpenAI-compatible
Points an agent at any endpoint that implements the OpenAI chat completions API — for example, an internal LLM gateway.- Model and base URL are free text; the base URL must use
httporhttpsand may not target a loopback or link-local host - The base URL is the API root, including the version segment: requests go
to
<base URL>/chat/completions, so use e.g.https://gateway.acme.com/v1 - Small-model tasks run on the main model
- API key is optional — leave it blank if your endpoint authenticates requests some other way, such as a custom header
- You can add custom HTTP headers sent with every request. Header values may
include placeholders resolved per request from the caller’s identity:
{{userId}},{{userExternalId}},{{email}},{{username}},{{tenantId}},{{tenantName}},{{tenantUrl}},{{deploymentId}}, and{{agentId}}. A placeholder with no value for a request —{{userExternalId}}for a user who did not arrive through signed embedding, for example — is sent through as literal text
Custom Anthropic-compatible
Points an agent at any endpoint that implements the Anthropic messages API. Configuration is the same as Custom OpenAI-compatible: a free-text model and base URL, an optional API key, and optional custom headers with the same placeholders. As with Custom OpenAI-compatible, small-model tasks run on the main model. Unlike the OpenAI-compatible provider, requests go to<base URL>/v1/messages,
so leave out the version segment — use https://gateway.acme.com, not
https://gateway.acme.com/v1. The API key, when set, is sent in the
x-api-key header. Extended thinking is not available for this provider.