Skip to content

Admin Dashboard: Settings and BYOK

Settings contains controls that apply across your workspace. The current General tab manages BYOK; Usage shows the allowances and consumption information provided by your plan or deployment.

BYOK lets an end user override the configured chat model for one request without storing their provider key. Enable BYOK Enabled, then select the providers callers may use.

Requests send:

  • X-BYOK-Provider
  • X-BYOK-API-Key
  • X-BYOK-Model
  • X-BYOK-Base-URL only for openai_compatible or ollama

Hosted providers use fixed endpoints. A request-supplied base URL resolving to a private/internal destination is rejected. OpenAI-compatible and Ollama must therefore be selected explicitly; an empty allowlist permits the hosted provider set shown by the UI.

The expected result is a request-scoped model override billed by the selected provider. The key is used for the request and is not written to the model store.

Enterprise operators can reconcile BYOK settings at boot. When declarative values are set, they are the source of truth and can overwrite later Admin changes. Remove the declarative setting before handing ownership back to this page.

The Usage tab renders the current plan/limit payload when the deployment provides it. Cloud capacity and upgrade actions belong to the Cloud account surface; Enterprise capacity follows the customer agreement and operator configuration.

Only accept BYOK headers from trusted product paths. Treat custom endpoints as outbound network access, restrict the provider set, and never log X-BYOK-API-Key.