外部アプリ接続（Express モデル）
外部アプリ、IDE プラグイン、自作サービスから API で Cherry Studio Enterprise Express モデルを呼び出します。
前提条件
開始前に、以下を確認してください：
- 管理者が対象ユーザーに API Key を作成し、有効化していること
- 対象モデルが Express モデル で有効化されていること
- 現在のユーザーが所属するグループに、そのモデルへのアクセス権が付与されていること
- 企業版 API アドレスを取得済みであること。例：
https://api.enterprise.cherry-ai.com
関連ドキュメント：
必須設定
OpenAI プロトコル対応の多くの外部アプリでは、次の 3 つの設定だけで利用できます：
| 項目 | 設定値 | 説明 |
|---|---|---|
| Base URL / サーバーアドレス | 企業版 API アドレス | 例：https://api.enterprise.cherry-ai.com |
| API Key | ユーザー自身の API Key | 通常は sk- で始まる |
| Model | model-id@provider_id | Express モデルはプロバイダー接尾辞が必須 |
Base URL の補足：
- 外部アプリが自動で
/v1/chat/completionsを付与する場合は、通常https://api.enterprise.cherry-ai.comのようなルート URL を入力します - OpenAI 公式 SDK を使う場合は、
baseURLをhttps://api.enterprise.cherry-ai.com/v1に設定してください
モデル命名ルール
外部アプリから Express モデルを呼び出す場合、model フィールドは model-id@provider_id の形式で指定する必要があります。
形式：
model-name@x-express例：
qwen/qwen3-max@x-express注意： UI 上の表示名ではなく、実際の Model ID を使用してください。また、@x-express を必ず付けてください。付いていない場合、API は 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 Enterprise Express の役割を3文で紹介してください。"
}
],
"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 Type | OpenAI Compatible / OpenAI |
| Base URL | https://api.enterprise.cherry-ai.com |
| API Key | ユーザー自身の sk-... |
| Model | qwen/qwen3-max@x-express |
互換性について： この接続方法は、カスタムモデル名を手動で入力できる外部アプリで最も使いやすいです。標準の自動モデル一覧取得に強く依存するアプリでは、モデル名を手動入力する必要がある場合があります。
よくある質問
1. Provider is required と表示されるのはなぜですか？
通常、model にプロバイダー接尾辞が付いていないことが原因です。次の形式になっているか確認してください：
qwen/qwen3-max@x-express2. 401 Unauthorized または Key Expired と表示されるのはなぜですか？
次を確認してください：
- API Key が正しいか
- API Key の有効期限が切れていないか
- API Key が管理者によって無効化されていないか
3. モデルが存在しない、またはアクセス権がないと表示されるのはなぜですか？
次を確認してください：
- 対象モデルが Express モデル一覧で有効化されているか
- 現在のユーザーのグループにそのモデルの利用権限があるか
- モデル接尾辞が正しい Express カテゴリに対応しているか
4. Balance Insufficient と表示されるのはなぜですか？
通常、企業 Express 残高が不足しているか、そのモデルにクォータ制限があることを意味します。管理者に モデル管理 > Express で残高とモデル状態を確認してもらってください。