|
| 1 | +--- |
| 2 | +title: Using your LLM provider API keys with Copilot |
| 3 | +shortTitle: Use your own API keys |
| 4 | +intro: 'Learn how to integrate your preferred custom models with {% data variables.product.prodname_copilot %} by using your own LLM API keys, and make them available for organizations in your enterprise account.' |
| 5 | +versions: |
| 6 | + feature: copilot-byok |
| 7 | +topics: |
| 8 | + - Copilot |
| 9 | +contentType: how-tos |
| 10 | +allowTitleToDifferFromFilename: true |
| 11 | +--- |
| 12 | + |
| 13 | +{% data reusables.copilot.byok-intro %} |
| 14 | + |
| 15 | +## Why bring your own API keys? |
| 16 | + |
| 17 | +As an enterprise owner, you may have specific requirements for governance, data security, and compliance. Setting up your own API keys allows you to address: |
| 18 | + |
| 19 | +{% data reusables.copilot.byok-why %} |
| 20 | + |
| 21 | +## Adding your key to an enterprise account |
| 22 | + |
| 23 | +> [!IMPORTANT] We highly recommend adhering to the principle of least privilege by assigning only the minimum necessary scopes to your API keys. |
| 24 | +
|
| 25 | +After you've added your key and selected one or more models, you and members of your organizations will be able to use them with {% data variables.copilot.copilot_byok_supported_features %}. Your models will appear at the bottom of the model picker, under the enterprise name. |
| 26 | + |
| 27 | +{% data reusables.enterprise-accounts.access-enterprise %} |
| 28 | +{% data reusables.enterprise-accounts.ai-controls-tab %} |
| 29 | +1. In the sidebar, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**. |
| 30 | +1. Click **Configure allowed models**. |
| 31 | +{% data reusables.copilot.byok-add %} |
| 32 | + |
| 33 | +## Managing availability of custom models in your organizations |
| 34 | + |
| 35 | +You can choose whether the models you have added are available to organizations in your enterprise account. |
| 36 | + |
| 37 | +{% data reusables.enterprise-accounts.access-enterprise %} |
| 38 | +{% data reusables.enterprise-accounts.ai-controls-tab %} |
| 39 | +1. In the sidebar, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**. |
| 40 | +1. Click **Configure allowed models**. |
| 41 | +1. Click the **Custom models** tab. |
| 42 | +1. Above the list of API keys, click the **Added models** tab. |
| 43 | +1. Next to a model, click **Configure**. If any organizations already have access to the model, instead of "Configure", you will need to click **All organizations** or **X organizations**. |
| 44 | +1. In the modal that opens, click the **Access** tab. |
| 45 | + >[!NOTE] The model must be set to 'Enabled' before the "Access" tab will be available. |
| 46 | +1. Choose how the model should be made available to organizations: |
| 47 | + * To make the model available to all organizations in your enterprise account, select **Allow for all organizations**. |
| 48 | + * To only make the model available for specific organizations, select **Choose per organization**, and check or uncheck the organizations listed below. |
| 49 | +1. Click **Save**. |
| 50 | + |
| 51 | +## Further reading |
| 52 | + |
| 53 | +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/use-your-own-api-keys) in our documentation for organizations. |
| 54 | +* [AUTOTITLE](/copilot/concepts/chat) |
0 commit comments