APIサーバー

APIサーバーの核心的な役割：Cherry Studioで設定済みのAI機能を、ローカルインターフェースを通じて外部に公開する（同時にエージェント機能の基盤依存でもあります）、他のプログラムから呼び出せるようにします。

使用シーン：Cherry StudioでOpenAI、Anthropic、DeepSeekなどのプロバイダーを設定済みです。もし他のツール（たとえばあるプラグインやカスタムスクリプト）が同じAI機能を呼び出したい場合、API サーバーこのローカルで標準インターフェースを公開し、これらのツールがCherry Studioの既存設定を直接再利用できるようにします。各社アカウントを重複登録する必要はありません。

いつ有効化する必要がありますか？

使用するエージェントをクリック → 有効化が必要
AgentをIMプラットフォームに接続する（チャンネル）→ 有効化が必要
Cherry Studioの通常の対話、描画、翻訳などの機能のみを使用する → 有効化不要

まずはこちらを読むことをおすすめします概念入門 Agent、チャネルなどの関連概念を理解します。

APIサーバーを有効化

開く 設定 → API サーバー
デフォルトのリッスンポートは 23333で、 1000-65535 の間の任意の空きポートを入力できます
右上の緑の ▶ 起動 ボタン

起動成功後、状態は緑に変わり 実行中、リッスンアドレスが表示されます http://127.0.0.1:<port>に由来する：

ポートを変更する方法：ポート入力欄はサーバー実行中は読み取り専用です。変更したい場合は、先に ⏹ をクリックして停止し、ポートを変更してから再起動してください。

APIキーと認証ヘッダー

API キーのような形で cs-sk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx、APIサーバーを初めて有効化したときに自動生成され、継続して保持され、サーバーを再起動しても更新されません。

手動で更新したい場合：まず ⏹ をクリックしてサーバーを停止する必要があります。そうすると、キーの右側に 再生成 ボタンが表示されます（実行中はコピー按钮のみ表示）。クリックすると旧キーは直ちに無効になり、再起動時に新しいキーが生成されます。

APIを呼び出す際は、リクエストヘッダーに次を追加する必要があります：

Authorization: Bearer cs-sk-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

APIキーには、あなたのCherry Studio内のすべてのProviderへのアクセス権があります。公開ネットワークやチーム共有チャネルで露出させないでください。

APIドキュメントを見る

ページ右上の APIドキュメント ボタンをクリックすると、組み込みのOpenAPIインターフェースドキュメント（Swagger風）を開けます。完全なエンドポイントとリクエスト例が含まれます。

ポート競合の確認

起動に失敗し、 EADDRINUSE: address already in use 127.0.0.1:<port> と表示される場合：

別のCherry Studioインスタンスが同じポートを使用している可能性が高いです
⏹ をクリックして停止し、ポートを別の空き値に変更してから再起動してください
またはターミナルで lsof -i :<port>（macOS / Linux）を実行して使用中プロセスを特定し、対処してください

再起動と停止

再起動：↻ アイコンをクリックします。キー再生成後にすべての接続を強制的に更新する際によく使います
停止：赤い ⏹ アイコンをクリックすると、サービスは直ちに閉じられます。使用中のエージェントとチャンネルへの接続も同時に切断されます

APIサーバーは 127.0.0.1、表示されませんのみをリッスンし、ローカルネットワークや公開ネットワークには公開されません。別マシンからアクセスする必要がある場合は、SSHリバーストンネルなどの類似手段を併用してください。

次のステップ

有効化後、そのまま設定を続けられますエージェント
AgentをFeishu / Telegram / DiscordなどのIMプラットフォームに接続したい場合は、チャンネル

💡 ヘルプの取得とフィードバックの送信

設定や使用の過程で疑問、Bug、機能改善の提案がある場合は、フィードバックと提案に記載の公式チャネルをご参照ください。

前へCode Tools使用ガイド次へスキル

最終更新 1 か月前

役に立ちましたか？