> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.agnes-ai.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# Cherry Studio Integration Guide

> Cherry Studio Integration Guide for Agnes Models

# Cherry Studio Integration Guide for Agnes Models

## 1. Overview

This document explains how to configure Agnes custom models in Cherry Studio. After the setup is complete, Cherry Studio can call Agnes text models for conversations. Agnes image and video models can also be used through Skills or by binding them to agents.

## 2. Prerequisites

Before you start, make sure you have:

* Cherry Studio installed.
* An Agnes AI API Key.
* A network environment that can access the Agnes AI API Gateway.
* The model name you want to use.

## 3. Get an Agnes API Key

Visit the Agnes AI Platform:

[https://platform.agnes-ai.com/](https://platform.agnes-ai.com/)

After logging in, go to the API Key page, create an API Key, and copy it.

## 4. Add a Provider

Open Cherry Studio and go to the API provider or model settings page.

Click:

```text theme={null}
Add Provider
```

## 5. Select the Provider Type

For the provider type, select:

```text theme={null}
OpenAI
```

Alternatively, select a custom provider type that supports OpenAI-Compatible APIs.

## 6. Enter the Provider Name

You can set the provider name as:

```text theme={null}
Agnes
```

You may also use a name that is easier to identify, such as:

```text theme={null}
Agnes AI
```

## 7. Enter the API Key

In the API Key field, enter the API Key obtained from the Agnes AI Platform.

Example:

<span class="field-row"><code>YOUR\_API\_KEY</code></span>

In most cases, you do not need to manually add the `Bearer` prefix.

## 8. Enter the API Base URL

Set the API Base URL to:

<span class="field-row"><code>[https://apihub.agnes-ai.com/v1](https://apihub.agnes-ai.com/v1)</code></span>

Usually, you do not need to enter the full `/chat/completions` endpoint.

Recommended format:

<span class="field-row"><code>[https://apihub.agnes-ai.com/v1](https://apihub.agnes-ai.com/v1)</code></span>

Not recommended:

<span class="field-row"><code>[https://apihub.agnes-ai.com/v1/chat/completions](https://apihub.agnes-ai.com/v1/chat/completions)</code></span>

Only use the full endpoint URL if Cherry Studio explicitly requires it.

## 9. Fetch the Model List

Click to fetch the model list.

If the API Key and API Base URL are correct, Cherry Studio should be able to retrieve the available Agnes models.

Select the text model:

<span class="field-row"><code>agnes-2.0-flash</code></span>

## 10. Save the Configuration

After confirming that the provider name, API Key, API Base URL, and model name are correct, click Save.

Once saved successfully, the Agnes model will appear in the model list.

## 11. Verify the Text Model

Create a new chat in Cherry Studio and select:

<span class="field-row"><code>agnes-2.0-flash</code></span>

Send a test message:

```text theme={null}
Hello, please introduce Agnes AI.
```

If the configuration is correct, Cherry Studio should return a normal model response.

## 12. Using Image and Video Models

In Cherry Studio, image and video models are recommended to be used by creating Skills and binding them to agents.

You can create an Agnes Image Skill to call the Agnes image model.

Example Skill name:

```text theme={null}
Agnes Image Skill
```

You can also create an Agnes Video Skill to call the Agnes video model.

Example Skill name:

```text theme={null}
Agnes Video Skill
```

After creating the Skills, bind them to an agent. You can then generate images or videos through conversations.

## 13. Troubleshooting

### 1. Unable to fetch the model list

Check whether the API Base URL is correct:

<span class="field-row"><code>[https://apihub.agnes-ai.com/v1](https://apihub.agnes-ai.com/v1)</code></span>

Also confirm that the API Key is valid.

### 2. Authentication failed

Make sure the API Key is entered correctly and that the account has sufficient balance or credits.

### 3. Model not found

Confirm that the model name is correct.

Recommended model:

<span class="field-row"><code>agnes-2.0-flash</code></span>

### 4. Text model works, but image or video models do not

Cherry Studio’s standard OpenAI-Compatible text model configuration is usually suitable for text conversations only.

For image and video models, it is recommended to use Skills or bind them as agent tools.

### 5. Request failed

Check your network, firewall, proxy, or VPN settings.