# Coze Integration Guide

Coze is an AI application development platform by ByteDance. This guide explains how to use it to call models via the UModelverse platform.

> **Note:** Custom model integration requires upgrading to the **Personal Advanced plan or above**.

## **1. Get an API Key**

Visit the [UModelverse Console](https://console.ucloud.cn/modelverse/api) to obtain your API key. For available models, see the [supported models](https://api-us-ca.umodelverse.ai/v1/models) on the UModelverse platform.

## **2. Add a Custom Model**

1. Go to the Coze **Model Management** page and click **+ Add Model** in the top right corner.

    ![Coze Model Management page](https://cdnv2-cache.udelivrs.com/2026/06/788cf87673a64384877265ce087b3266_1781261163458.png)

2. In the dialog, switch to the **Custom Integration** tab and fill in the fields as follows:

    ![Coze custom integration fields](https://cdnv2-cache.udelivrs.com/2026/06/1fd437ff772f601ea681343af6002006_1781261163463.png)

| Field | Value |
| --- | --- |
| Model display name | Any name you like, e.g. `qwen3.7-max` |
| Model ID | One of the [supported models](https://api-us-ca.umodelverse.ai/v1/models) on UModelverse, e.g. `qwen3.7-max` |
| Model protocol | Select **Chat API** |
| API URL | `https://api-us-ca.umodelverse.ai/v1` |
| API Key | Your UModelverse [API Key](https://console.ucloud.cn/modelverse/api) |
| Advanced - Image understanding | Enable if you need to send images in conversations (vision models only) |
| Advanced - Max reply length | Choose based on the model's context length; **64K** is recommended |

3. Click **Add**. The model will then be available when creating or editing agents and workflows.

## **FAQ**

### Authentication failure or connection error when calling the model?

Check the following:

1. The API Key is from the UModelverse platform — copied in full with no extra spaces.

2. The API URL is `https://api-us-ca.umodelverse.ai/v1` (with `/v1`).

3. The Model ID exactly matches one of the [supported models](https://api-us-ca.umodelverse.ai/v1/models) on the UModelverse platform.
