Help Center/ CodeArts Agent/ User Guide (Console)/ Models/ Configure Enterprise Custom Models
Updated on 2026-09-17 GMT+08:00
View PDF
Share

Configure Enterprise Custom Models

CodeArts Agent allows enterprises to access third-party large language models. You can flexibly customize the models based on your service scenarios to meet your requirements for on-premises deployment, data security, and compliance control.

CodeArts Agent allows you to configure custom models on both the console and client. The permission requirements for the two configuration methods are different.

  • On the console: Only enterprise administrators can configure custom models and manage client-side configuration permissions for members.
  • On the client: All enterprise members can configure custom models.

The support for custom models varies depending on the package. For details, see Table 1.

Table 1 Support for custom models across different packages

Package Edition

Configuring Custom Models on the Console

Configuring Custom Models on the Client

Free edition and basic edition

×

√

Professional edition

√

√

This section describes how an enterprise administrator configures custom models on the console. For details about how to configure custom models on the client, see Models.

Constraints

Table 2 Constraints

Category

Description

API format

Only the OpenAI Chat Completions Format and Anthropic Messages Format are supported.

Quantity

A single tenant can create a maximum of 100 custom models.

Calling tool

Custom models cannot be invoked in the Ask mode. They can be invoked only by system built-in agents, AgentTeam, and custom agents.

Token consumption

When you call custom models, tokens from the CodeArts Agent package are not consumed. However, to minimize inference latency, the code generation function uses dedicated built-in models and does not support custom models.

Version difference

Custom models created in versions earlier than 26.9.6 must be added to the basic models of the system built-in agent before they can be used on the client. For details, see Modifying the Basic Model of a System Built-in Agent.

Prerequisites

  • You have purchased the CodeArts Agent professional edition package.
  • You have obtained the model ID, model URL, and API key from the model provider. It is necessary to create a custom model.

Step 1: Creating a Custom Model

You can create a custom model on the CodeArts Agent console via a provider or custom configuration.

  • Via providers: CodeArts Agent is preset with some LLMs from mainstream providers. Once you select the provider and model ID, CodeArts Agent automatically populates the model URL. You only need to configure the API key for a quick setup.
  • Via custom configuration: You must manually specify the model URL, model ID, and API key. This method is suitable for integrating self-hosted local models or models from providers not included in the preset list.
  1. Log in to the CodeArts Agent console using an enterprise administrator account.
  2. In the navigation tree on the left, choose Enterprise Settings > Models. The Models page is displayed.
  3. In Custom Models, click Create Model. The Create Model dialog box is displayed.
  4. Select Model provider, and set parameters by referring to Table 3.

    Figure 1 Creating a model via provider
    Table 3 Parameters for creating a model via provider

    Parameter

    Description

    Model provider

    Select the provider to which the model to be created belongs from the drop-down list.

    Model ID

    Select the ID of the model to be created. If the required model ID is not in the list, select Custom.

    Custom Model ID

    This parameter is available only when Model ID is set to Custom.

    Enter the model ID obtained from the model provider.

    Custom Model Name

    Enter the name of a model displayed in CodeArts Agent. The name contains a maximum of 64 characters.

    The model display name can be the same as the name of a built-in model, but cannot be the same as the name of any other custom model.

    API Key

    Enter the API key obtained from the model provider.

    Available For

    Specify the application scope of the custom model, which cannot be modified after creation.

    • Enterprise: available to all enterprise members.
    • Team: available only to specified teams.

    Enterprise administrators can use all enterprise-level and team-level custom models.

    Select Team

    This parameter is displayed when Available For is set to Team.

    Select one or more teams from the drop-down list.

    Custom Model URL

    Optional. After you select a provider, the system automatically enters the model URL.

    To modify the model URL, enable Custom Edit and enter the model URL. Enter only the base URL of the API. For example, if the model address is https://open.bigmodel.cn/api/paas/v4/chat/completions, enter https://open.bigmodel.cn/api/paas/v4 here.

    Context Window

    Optional. Set the input tokens and output tokens.

    • Input Tokens: indicates the maximum number of tokens that can be received by the model in a single request.
    • Output Tokens: indicates the maximum number of tokens that can be delivered by the model in a single response.

    Description

    Optional. Enter a maximum of 200 characters to describe the custom model.

  5. Click OK.

    The model is displayed in the Custom Models area and is enabled by default.

  1. Log in to the CodeArts Agent console using an enterprise administrator account.
  2. In the navigation tree on the left, choose Enterprise Settings > Models. The Models page is displayed.
  3. In Custom Models, click Create Model. The Create Model dialog box is displayed.
  4. Select Custom, and set parameters by referring to Table 4.

    Figure 2 Creating a model via custom configurations
    Table 4 Parameters for creating a model via custom configurations

    Parameter

    Description

    API Format

    Select the API format used by the model from the drop-down list. Only OpenAI Chat Completions Format and Anthropic Messages Format are supported.

    Model URL

    Enter the model URL obtained from the model provider. Enter only the base URL of the API.

    For example, if the model address is https://open.bigmodel.cn/api/paas/v4/chat/completions, enter https://open.bigmodel.cn/api/paas/v4 here.

    Model ID

    Enter the model ID obtained from the model vendor. The value contains a maximum of 64 characters. For example, glm-5.1.

    Custom Model Name

    Enter the name of a model displayed in CodeArts Agent. The name contains a maximum of 64 characters.

    The model display name can be the same as the name of a built-in model, but cannot be the same as the name of any other custom model.

    API Key

    Enter the API key obtained from the model provider.

    Available For

    Specify the application scope of the custom model, which cannot be modified after creation.

    • Enterprise: available to all enterprise members.
    • Team: available only to specified teams.

    Enterprise administrators can use all enterprise-level and team-level custom models.

    Select Team

    This parameter is displayed when Available For is set to Team.

    Select one or more teams from the drop-down list.

    Context Window

    Optional. Set the input tokens and output tokens.

    • Input Tokens: indicates the maximum number of tokens that can be received by the model in a single request.
    • Output Tokens: indicates the maximum number of tokens that can be delivered by the model in a single response.

    Description

    Optional. Enter a maximum of 200 characters to describe the custom model.

  5. Click OK.

    The model is displayed in the Custom Models area and is enabled by default.

Step 2: Using the Custom Model

When an enterprise member uses a custom model for inference on the client, the tokens in their CodeArts Agent package are not consumed. However, the code completion function cannot use custom models, because it has to use the dedicated built-in models to reduce the inference delay.

  1. Log in to the CodeArts Agent client as an enterprise member or administrator.
  2. In the lower part of the chat box, choose Built-in > Agent, or choose Custom and select a custom model from the model list on the right.

    Team-level custom models can be used only by team members (including team administrators) and enterprise administrators.

Configuring Members' Permissions to Create Custom Models

From the console, enterprise administrators centrally control whether members are permitted to configure custom models on the client side. If this function is enabled, members can add and use custom models. If not, they cannot.

  1. Log in to the CodeArts Agent console using an enterprise administrator account.
  2. In the navigation tree on the left, choose Enterprise Settings > Models. The Models page is displayed.
  3. In the Member Custom Model Permissions area, enable or disable the function.

    • Enabled: Allows enterprise members to add custom models on the CodeArts Agent client.
    • Disabled: Forbids enterprise members from adding custom models on the CodeArts Agent client.

Managing Custom Models

After custom models are created, enterprise administrators can perform the operations listed in Table 5.

Table 5 Managing custom models

Operation

Procedure

Search for a custom model.

In the search box of Custom Models, enter a model name to search for the model.

Enable or disable a custom model.

In the Custom Models area, locate the target model, and click to disable it or to enable it.

Once disabled, the model will no longer be displayed in the chat input box on the client.

Edit a custom model.
  1. In the Custom Model area, locate the target model, and click Edit in the Operation column. The Edit Model dialog box is displayed.
  2. Modify the model parameters, and click OK.

Delete a custom model.
  1. In the Custom Model area, locate the target model, and click Delete in the Operation column. A confirmation dialog box is displayed.
  2. Confirm the deletion, and click OK.

    The target model is not displayed in the Custom Models area, indicating that the model is deleted successfully.

    CAUTION:

    Once deleted, the model cannot be used by any enterprise members. Exercise caution when performing this operation.
Parent Topic: Models