Skip to content
文档

外部应用接入(Express 模型)

在外部应用、IDE 插件或自建服务中,通过 API 调用 Cherry Studio 企业版 Express 模型。

适用前提

开始前,请先确认以下条件已经满足:

  1. 管理员已经为当前用户创建并启用了 API Key。
  2. 管理员已经在 Express 模型 中启用了目标模型。
  3. 当前用户所属分组已经被授权可访问该模型。
  4. 您已经拿到企业版 API 地址,例如 https://api.enterprise.cherry-ai.com。

相关文档:

配置项对应关系

在大多数支持 OpenAI 协议的外部应用中,您只需要填写以下 3 个核心参数:

配置项填写内容说明
Base URL / 服务器地址企业版 API 地址例如 https://api.enterprise.cherry-ai.com
API Key用户自己的 API Key形如 sk-...
Model模型 ID@provider_idExpress 模型必须带上服务商后缀

填写 Base URL 的小提示:

  • 如果外部应用会自动拼接 /v1/chat/completions,通常填写根地址即可,例如 https://api.enterprise.cherry-ai.com
  • 如果您使用的是 OpenAI 官方 SDK,需要把 baseURL 写成 https://api.enterprise.cherry-ai.com/v1

模型命名规则

Express 模型在外部应用中调用时,model 字段必须写成 模型 ID@provider_id。

格式:

模型名字@x-express

示例:

qwen/qwen3-max@x-express

注意: 这里要填写的是 模型 ID,不是页面上的展示名称。并且必须带上 @x-express 后缀,否则接口会返回 Provider is required。

通用请求示例

cURL

curl https://api.enterprise.cherry-ai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{
    "model": "qwen/qwen3-max@x-express",
    "messages": [
      {
        "role": "user",
        "content": "请用三句话介绍 Cherry Studio 企业版 Express 的作用"
      }
    ],
    "stream": false
  }'

Node.js(OpenAI SDK)

import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: process.env.CHERRY_API_KEY,
  baseURL: 'https://api.enterprise.cherry-ai.com/v1'
})

const completion = await client.chat.completions.create({
  model: 'qwen/qwen3-max@x-express',
  messages: [{ role: 'user', content: '你好,请介绍一下自己' }]
})

console.log(completion.choices[0]?.message?.content)

Python(OpenAI SDK)

from openai import OpenAI

client = OpenAI(
    api_key="sk-your-api-key",
    base_url="https://api.enterprise.cherry-ai.com/v1",
)

resp = client.chat.completions.create(
    model="qwen/qwen3-max@x-express",
    messages=[{"role": "user", "content": "你好,请介绍一下自己"}],
)

print(resp.choices[0].message.content)

外部应用中的推荐填写方式

如果您使用的是聊天工具、IDE 插件或其他第三方应用,通常可以按下面的方式配置:

字段推荐填写
Provider TypeOpenAI Compatible / OpenAI
Base URLhttps://api.enterprise.cherry-ai.com
API Key用户自己的 sk-...
Modelqwen/qwen3-max@x-express

兼容性说明: 当前更推荐用于支持"手动填写自定义模型名"的外部应用。若某个应用强依赖标准的自动拉取模型列表能力,可能还需要您手动补充模型名。

常见问题

1. 为什么提示 Provider is required?

通常是因为 model 没有带服务商后缀。请检查是否写成了下面这种完整格式:

qwen/qwen3-max@x-express

2. 为什么提示 401 Unauthorized 或 Key Expired?

请检查:

  1. API Key 是否填写错误
  2. API Key 是否已过期
  3. API Key 是否已被管理员禁用

3. 为什么提示模型不存在或没有权限?

请检查:

  1. 目标模型是否已经在 Express 模型列表中启用
  2. 当前用户所属分组是否已被授权使用该模型
  3. 模型后缀是否与后台所属分类一致

4. 为什么提示 Balance Insufficient?

通常表示企业 Express 余额不足,或该模型受到了额度限制。请联系管理员前往 模型管理 > Express 查看余额与模型状态。