diff --git a/product-guide/docs.json b/product-guide/docs.json index 635e01f..1762a95 100644 --- a/product-guide/docs.json +++ b/product-guide/docs.json @@ -48,6 +48,7 @@ "platform/quickstart", "platform/key-concepts", "platform/configuration/settings", + "platform/configuration/ai-model", "platform/configuration/user-management", "platform/administration/roles-permissions" ] diff --git a/product-guide/platform/configuration/ai-model.mdx b/product-guide/platform/configuration/ai-model.mdx new file mode 100644 index 0000000..39bcdb4 --- /dev/null +++ b/product-guide/platform/configuration/ai-model.mdx @@ -0,0 +1,43 @@ +--- +title: Bring your own AI model +description: Power AI features with your own LLM provider and API key. +--- + +By default, AI features run on a managed model. Bring your own key (BYOK) lets you supply your own LLM provider, model, and API key instead. Use BYOK when your organization requires a specific model, has an existing provider agreement, or needs AI traffic billed to its own provider account. + +The model you configure powers all AI products in your deployment. + + + BYOK is available on Enterprise plans. Configuring the AI model requires permission to update assistant settings. Members without this permission can view the configuration but cannot change it. + + +## Configure your model + +1. Go to **Settings → Organization → API keys**. +2. Find the **AI model** section and turn on the **Bring your own model** toggle. +3. Select a provider. +4. Select a model from the searchable list. Each provider shows a **Browse models** link if you want to compare options. +5. Enter your provider API key. +6. Click **Save**. + +## Providers + +Three provider options are supported: + +| Provider | Base URL | Notes | +|----------|----------|-------| +| **Anthropic** | `https://api.anthropic.com/v1` | Choose from supported Claude models. | +| **OpenRouter** | `https://openrouter.ai/api/v1` | Choose from supported models across Anthropic, OpenAI, Google, xAI, and other model families. | +| **OpenAI-compatible** | Custom | Any endpoint that implements the OpenAI API format. Set your own provider name and base URL. | + +For the OpenAI-compatible option, the base URL must be a valid HTTPS URL. The dashboard rejects unsafe or malformed URLs when you save. + +## API key handling + +- Your API key is stored securely and never displayed after saving. +- The saved key is reused when you switch models within the same provider. You only re-enter a key when you change providers or the base URL. +- To rotate a key, enter the new key in the **API key** field and click **Save**. Leaving the field blank keeps your saved key. + +## Disable BYOK + +Turn off the **Bring your own model** toggle to remove your provider configuration and stored API key. AI features revert to the managed default model.