Skip to content

Bind Codebyby in Cherry Studio

Cherry Studio is a desktop AI assistant client that supports custom OpenAI-compatible providers. You can add Codebyby as a custom provider, then use the models and quota provided by Codebyby inside Cherry Studio.

1. Prerequisites

Before you start, make sure you have:

  • Registered and logged in to the Codebyby console
  • Created an API Key in the console
  • Confirmed the current relay API base URL
  • Installed the Cherry Studio desktop client

If you have not created a key yet, read Quick Start first.

2. Get your Codebyby API Key

  1. Open the Codebyby console.
  2. Go to the API Keys page.
  3. Click Create Key and give it a recognizable name, such as cherry-studio.
  4. Copy the generated API Key and store it safely.

Note: Keep your API Key on your own device or in a password manager. Do not post it in chats, screenshots, or code repositories.

3. Add a provider in Cherry Studio

  1. Open Cherry Studio.
  2. Go to Settings.
  3. Find Model Services or Model Providers.
  4. Click Add or New Provider.
  5. Select OpenAI Compatible or Custom OpenAI as the provider type.

The wording may vary between Cherry Studio versions. The key point is to choose a provider type that supports a custom API base URL and API Key.

4. Fill in Codebyby connection settings

Use the following values when adding the provider:

FieldValue
NameCodebyby
API Address / Base URLThe relay base URL provided by the Codebyby console
API KeyThe API Key created in the Codebyby console
API TypeOpenAI Compatible
ModelSelect or manually enter a model name supported by Codebyby

The Base URL should be the API base path only. Do not append the chat endpoint manually. A common mistake is adding /chat/completions to the Base URL, which causes duplicated request paths.

5. Add or refresh models

After saving the provider, add models according to your Cherry Studio version:

  • If Auto Fetch Models is available, click refresh or sync.
  • If models must be added manually, enter a model name available in Codebyby.
  • If you are unsure about the model name, check the Codebyby console.

After adding a model, return to the chat page and select the Codebyby model from the model picker.

6. Send a test message

Start with a short message:

text
Hello, reply in one sentence to confirm the connection is working.

If Cherry Studio returns a normal response, the Codebyby binding is complete.

7. Troubleshooting

401 or Unauthorized

The API Key is usually wrong, contains extra spaces, or has been deleted. Copy a valid key from the Codebyby console again.

404 or model not found

The model name is usually incorrect, or the current key does not have access to that model. Make sure the model name matches the Codebyby console.

Network error or connection failed

First check that the Base URL is the Codebyby relay address, not the original upstream provider address. Also check whether local proxy, firewall, or network settings block Cherry Studio.

Provider can be saved but chat fails

Check whether the Base URL includes duplicated endpoint paths, such as adding /v1/chat/completions manually. In most cases, only the base address is needed, and Cherry Studio appends endpoint paths automatically.

  • Create a separate API Key for Cherry Studio to make usage tracking and rotation easier.
  • Name the provider Codebyby so it is easy to identify during troubleshooting.
  • After replacing a key, send a short test message before long conversations.
  • Do not put real API Keys in public docs, screenshots, or logs.

After completing these steps, you can use Codebyby models in Cherry Studio.

Codebyby documentation site.