Skip to main content

​
概要

プラグイン hellojint/updream-openai-compatible-plugin（GitHub）は、汎用 OpenAI 互換画像プロトコルに対応した Updream Desktop v0.2.0 向けのオープンソース画像生成プラグインです。インストールすると、デスクトップクライアントは OpenAI Images インターフェースに準拠する任意のサードパーティ API アップストリームに画像生成リクエストを転送します —— APIYI は API パスにおいてこの要件を満たしています。
プロジェクト情報
  • ソース: github.com/hellojint/updream-openai-compatible-plugin (GitHub)
  • ライセンス: MIT
  • 作者: hellojint
  • プラグインパッケージ名: updream-openai-compatible-v1.updplugin
  • ベース: 公式 Updream プラグイン作成ガイドの OpenAI 画像プロバイダーサンプル
2 つの統合パス「ローカルでのタスク実行 / ローカルでの認証情報保存」を必要としない場合は、Updream ウェブクライアントをおすすめします: Updream と APIYI の統合（ウェブ）。ウェブクライアントは、「外部モデルコネクタ」スキル + OpenAI 互換プロトコル経由で APIYI に接続し、プラグインのインストールは不要です —— ほとんどのユーザーにとって推奨されるパスです。ここで説明するデスクトップ + プラグインのパスは、API キーをローカルに保持する必要があるユーザー、バッチ画像生成ジョブを実行するユーザー、またはウェブクライアントで OpenAI Images プロトコルの制限に達したユーザー向けです。

​
コア機能

汎用的なOpenAI互換プロトコル

/v1/images/generationsを公開し、Bearerで認証を行う任意のアップストリームで動作します。APIYIはこれを満たしています。

デスクトップ上でのローカル実行

タスクはUpdream Desktop v0.2.0でローカルに実行され、Webキャンバスに結果を返します。

APIキーのローカル保存

キーはUpdreamのシステムキーチェーンに保持され、実行時に読み取られます。プラグイン自体には認証情報は同梱されていません。

複数のプロバイダーの併用

デスクトップクライアントは複数のプロバイダー（例: openai、apiyi-compatible）を保持し、それらを切り替えることができます。

サイズの自動マッピング

デスクトップの鮮明度とアスペクト比は、アップストリームのsizeパラメーターに自動マッピングされます。ハードコードされたextra.sizeはこのマッピングを上書きします。

複数のレスポンス形式

data[].url、data[].b64_json、トップレベルのurlなどに対応しています。MIMEはBase64から判別されます。

​
APIYI モデル例

以下のIDはエンドポイント IDフィールドに入力できます。これらはあくまで例です：
実際にサポートされているモデルは、APIYI 推奨モデルページに記載されています。この表は、プラグインが受け付けるフィールド形式を示しているに過ぎません。

​
プラグイン設定項目

プラグインがデスクトップクライアントに読み込まれると、APIキーの追加フォームには以下の項目が表示されます： APIキーは機密情報です。実際のキーをスクリーンショット、ドキュメント、Issue、README、またはチャットに貼り付けないでください。APIYI コンソールでデスクトップクライアント専用の利用上限付きキーを作成し、使用が終わったら失効させてください。

​
インストールと設定（手順ガイド）

​
ステップ 0: デスクトップクライアントの概要

Updream Desktop のタスク概要 (v0.2.0) v0.2.0 のデフォルトレイアウト：左側に「Local execution（ローカル実行）」タスクリスト、上部バーに Sync / Add Key / Import Plugin / Manage Plugins、右下にバージョンラベル v0.2.0 が表示されます。

​
ステップ 1: プラグインのインポート

デスクトップ上部バーの「Import Plugin」エントリ 上部にある Import Plugin ボタンをクリックします。ファイルピッカーでダウンロードした updream-openai-compatible-v1.updplugin を選択し、確認を求められたらインストールを承認（confirm the install）します。作者は承認前に plugin.py を確認することを推奨しています。

​
ステップ 2: インストールの確認

プラグインのインストール状態 Manage Plugins ページに Universal OpenAI-compatible Image (universal-openai-compatible-image · v1.0.0 · image) が表示されます。この時点で、デスクトップクライアントは任意の OpenAI Images 互換のアップストリームを呼び出す準備が整いました。

​
ステップ 3: キーの追加

デスクトップ上部バーの「Add Key」エントリ Add Key ボタンをクリックして設定フォームを開きます。

​
ステップ 4: APIYI の設定

APIYI の設定例 スクリーンショットの例に従ってフォームに入力します。 Test connection と Test generation をクリックします。Connection succeeded! API available と表示されたら、設定を保存します。

​
ステップ 5: プロバイダーが有効になっていることを確認

プロバイダー一覧 Configuration ページのプロバイダーリストに、新しく apiyi-compatible のエントリが表示されます。そのプロバイダー識別子は plugin:universal-openai-compatible-image で、ステータスは Enabled になっています。プロバイダーの切り替えや無効化はいつでも行えます。
デスクトップでの設定完了後、Updream の Webクライアント を再度開きます。キャンバスノードの画像生成プロバイダードロップダウンで apiyi-compatible を選択すると、Webクライアントからタスクを発行し、デスクトップクライアントで実行させることができます。

​
使用方法: Web → デスクトップ → Web ループ

上記の5つのステップの後、Updream Webクライアントから画像生成を実行すると、デスクトップ側の apiyi-compatible プロバイダーが使用され、https://api.apiyi.com/v1/images/generations へ転送されます。生成結果はWebキャンバスのノードへと戻されます。 デスクトップクライアントから生成結果を受信するWebクライアント スクリーンショットでは、キャンバスの下のパネルに「画像生成 + apiyi-compatible（矢印の位置）+ 16:9 / 2K / ×1」と表示されています。これは、Updream Webクライアントで開始され、デスクトップクライアントで実行されてWebキャンバスに戻ったタスクの視覚的な結果です。

​
よくある質問

デスクトップクライアントのバージョンが ≥ v0.2.0 であることを確認してください。以前のバージョンにはプラグインのサポートがないため、まずUpdream Desktopをアップグレードする必要があります。
  1. .updpluginアーカイブのルート直下にplugin.pyが含まれており、manifest.entryと一致していることを確認します
  2. デスクトップクライアントを再起動します
  3. プラグイン管理ページで、プラグインのステータスが無効になっていないことを確認します
  1. エンドポイントIDのスペルが正しく、APIYIの最新モデルリストに存在することを確認します
  2. アカウント残高が十分であることを確認します（残高があるにもかかわらずアカウントで失敗するのはなぜですか？を参照）
  3. デスクトップクライアントのローカル実行ページで詳細なエラーコードを確認します
Webクライアントはこのプラグインを経由しません。OpenAI互換プロトコル設定でWebクライアントの外部モデルコネクタースキルを使用するか、APIYIとUpdreamの連携（Web）を参照してください。
manifest.json.versionを更新し、再パッケージ化します：
ZIPアーカイブのルート直下にplugin.pyが含まれている必要があります。
いいえ。プラグインには認証情報は一切含まれていません。キーはUpdreamのキーチェーンに保存され、実行時にcfg.get('api_key')経由で読み込まれます。実際のキーをplugin.py、README、Issue、チャットなどに貼り付けないでください。

​
関連リソース

APIYIとのUpdream連携（Web版、推奨）

WebクライアントはExternal Model Connectorスキルを通じてAPIYIに接続します — プラグインは不要です

hellojint/updream-openai-compatible-plugin

このドキュメントが基づいているオープンソースリポジトリ（MITライセンス）：github.com/hellojint/updream-openai-compatible-plugin

APIYI推奨モデル

現在APIYIでサポートされている画像モデルと料金を確認できます

APIYI APIキー管理

APIキーの作成と管理に関するベストプラクティス

APIYIコンソール

専用キーの作成、使用量の確認、残高上限の設定を行えます

APIYIの連携と利用方法

API連携およびOpenAI互換プロトコルの概要