For the complete documentation index, see llms.txt. This page is also available as Markdown.

APIゲートウェイ

APIゲートウェイは、Cherry Studio に設定済みのモデル機能を OpenAI および Anthropic 互換の HTTP API としてローカルのプログラムに提供します。これは Agent の実行に必要な内部サービスでもあります。

パス:【設定】→【APIゲートウェイ】。

API 网关设置中的运行状态、连接地址、端口和访问凭据
外部プログラムを接続する前に、状態とポートを確認してください。キーは信頼できるローカルプログラムまたは制御されたネットワークにのみ提供してください。

Agent の使用と外部呼び出しは区別する

  • Cherry Studio の Agent のみを使う場合:アプリの案内に従って【有効にして起動】するだけでよく、URL やキーを他のプログラムにコピーする必要はありません。

  • ローカルプログラムから Cherry Studio を呼び出す場合:ゲートウェイを起動し、URL と API キーをコピーして、API ドキュメントに従って互換インターフェースを選択してください。

  • 他のデバイスからアクセスさせる場合:公開範囲が広がるため、ネットワークのリッスン設定、ファイアウォール、アクセス制御を自分で確認する必要があります。安全対策がない状態での公開は推奨しません。

起動と接続

1

1. ポートを確認

ゲートウェイ停止中はポートを変更できます。ほかのプログラムが使用していないポートを選んでください。ポート競合があるとサービスは正常に起動できません。

2

2. ゲートウェイを起動

【起動】をクリックし、状態が【実行中】に変わると、ページに利用可能な URL が表示され、【API ドキュメント】への入口も提供されます。

3

3. 認証を設定

外部プログラムの使用 Authorization: Bearer <APIキー>。ページから認証ヘッダーを直接コピーできます。キーをコードリポジトリやスクリーンショットに記載しないでください。

4

4. 最小限のリクエストで検証

まず API ドキュメントに従ってモデル一覧を取得するか、短いテキストを送信してから、完全なアプリケーションを接続してください。エラーが発生した場合は HTTP ステータスとレスポンスを記録し、認証ヘッダー全体は公開しないでください。

使用シーン:ローカルスクリプトからモデルを呼び出す

まず【設定】→【モデルサービス】でモデルが正常に対話できることを確認してから、API ゲートウェイを起動します。スクリプトはローカルゲートウェイのアドレスとキーだけを保存し、最初にモデル一覧を取得してから、短い文を1つ送信します。完全なプログラムを接続する前に、クライアントが OpenAI 互換または Anthropic 互換のインターフェースをサポートしていることを確認してください。

設定
推奨の開始値
役割
注意事項

リッスン範囲

ローカルのみで使用

ネットワークへの露出を減らす

デバッグのために、直接 LAN や公開ネットワークに開放しない

API キー

現在のゲートウェイ専用に保管する

クライアントのリクエストを検証する

リポジトリ、スクリーンショット、共有ログには書き込まない

リクエストを検証する

まずモデル一覧と短いテキストを確認する

接続と生成を分けて検証する

失敗時はステータスコードを記録し、完全なキーは記録しない

完了基準

ゲートウェイが【実行中】と表示される;モデル一覧が読み取れる;短いテキストのリクエストが成功する;ゲートウェイ停止後、クライアントは呼び出しを続けられない。

安全な操作

  • ゲートウェイ実行中はポートとキーは読み取り専用なので、変更前に先に停止してください。

  • 公開リポジトリ、Issue、ログ、またはチュートリアルのスクリーンショットでキーを表示しないでください。

  • 呼び出しが必要なプログラムにだけキーを保存する

  • 使用量と費用は実際のモデルサービス提供者によって発生し、【設定】→【使用量統計】で Cherry Studio の記録を確認できます。

API ゲートウェイとモデルサービスはどのような関係ですか?

モデルサービスは上流サービス提供者への接続を保存し、API ゲートウェイはそれらの機能を互換インターフェースに変換します。ゲートウェイ自体はモデルを提供せず、少なくとも1つの利用可能なサービス提供者とモデルが必要です。

ポートは正常なのに、クライアントが未認証を返すのはなぜですか?

リクエストヘッダーが Authorization: Bearer ...であることを確認し、余分な引用符や空白がないか確認してください。また、クライアントが使用しているキーが、ページ上の現在値と同じかどうかも確認してください。

最終更新

役に立ちましたか?