Cherry Studio Integration Guide

Integrate WOX models with Cherry Studio

Integrating WOX Models with Cherry Studio

1. Overview

This guide explains how to configure a custom WOX model in Cherry Studio. Once configured, Cherry Studio can call WOX text models for chat. WOX image and video models can also be used through Skills or by attaching them to an agent.

2. Prerequisites

Before you begin, make sure you have:

• Cherry Studio installed.
• A WOX API Key.
• A network connection that can reach the WOX API gateway.
• The name of the model you want to use.

3. Get a WOX API Key

Open the WOX platform:

WOX API Keys page

Sign in, open 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:

Add Provider

5. Select the Provider Type

For the provider type, select:

OpenAI

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

6. Enter a Provider Name

You can set the provider name to:

WOX

You can also use another name that is easy for you to recognize, for example:

WOX

7. Enter the API Key

In the API Key field, enter the API Key you obtained from the WOX platform.

Example:

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

8. Enter the API Base URL

Set the API Base URL to:

You usually do not need to enter the full /chat/completions endpoint.

Recommended format:

Not recommended:

Use the full endpoint URL only if Cherry Studio explicitly requires it.

9. Fetch the Model List

Click the option to fetch the model list.

If the API Key and API Base URL are correct, Cherry Studio should retrieve the available WOX models.

Select a text model:

10. Save the Configuration

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

Once saved, the WOX model will appear in the model list.

11. Test the Text Model

Create a new chat in Cherry Studio and select:

Send a test message:

Hello, please introduce WOX.

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

12. Use Image and Video Models

In Cherry Studio, we recommend using image and video models by creating Skills and attaching them to an agent.

You can create a WOX Image Skill to call a WOX image model.

Example Skill name:

WOX Image Skill

You can also create a WOX Video Skill to call a WOX video model.

Example Skill name:

WOX Video Skill

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

13. Troubleshooting

1. Unable to fetch the model list

Check that the API Base URL is correct:

Also confirm that the API Key is valid.

2. Authentication fails

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

3. Model not found

Confirm that the model name is correct.

Recommended model:

4. Text models work, but image or video models do not

Cherry Studio's standard OpenAI-compatible text model configuration generally applies only to text chat.

For image and video models, use Skills or attach the models as agent tools.

5. Request fails

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