Mage API · SDK
Mage API公式SDK
TypeScriptとPython向けの型付きクライアントと、ComfyUI向けのMageノード。画像・動画・音声のあらゆるモデルを、数行のコードで使えます。
ひと目でわかる概要
MageはAPI向けのオープンソースSDKを公開しています:TypeScript/JavaScript向けにnpmの @mage-space/sdk、Python向けにPyPIの mage-space、ComfyUI向けにノードパックの comfyui-mage です。いずれもREST APIをラップし、全37モデルの型付き設定、自動ポーリング、冪等なリトライ、アップロードに対応しています。
- 3SDKと連携
- 37型付きモデル
- MITオープンソース
- $0インストール
お好みのものを選択
SDKと連携
npm install @mage-space/sdkTypeScript SDK
Node.jsから画像・動画・音声を生成。すべてのMageモデルに型付き設定を用意しています。1回の呼び出しで送信から待機、結果の取得まで完了します。
pip install mage-spacePython SDK
Pythonから画像・動画・音声を生成。同期クライアントとasyncioクライアントに対応し、すべてのMageモデルに型付き設定を用意しています。
comfy node install comfyui-mageComfyUI向けMage
Mango、Cherry、Seed Audioをはじめ、Mageのすべてのモデルを ComfyUIノードとして利用可能。GPUもモデルのダウンロードも不要です。
クイックスタート
SDKで最初の生成をする
パッケージをインストールし、MAGE_API_KEYをexportして、モデルを実行しましょう。
TypeScript
// npm install @mage-space/sdk
import Mage from '@mage-space/sdk';
const mage = new Mage(); // reads MAGE_API_KEY
const request = await mage.run('mango', {
prompt: 'Editorial portrait in soft daylight, 35mm film look',
aspect_ratio: '4:5',
model_id: 'mango-v4',
});
console.log(request.result.url);Python
# pip install mage-space
from mage_space import Mage
mage = Mage() # reads MAGE_API_KEY
request = mage.run("mango", {
"prompt": "Editorial portrait in soft daylight, 35mm film look",
"aspect_ratio": "4:5",
"model_id": "mango-v4",
})
print(request["result"]["url"])標準搭載
すべてのSDKが代わりに処理してくれること
1回の呼び出しで、完成したメディアを取得
runは生成を送信し、APIが推奨するバックオフでポーリングして、result.urlを含む完了済みのリクエストを返します。
二重課金されないリトライ
送信にはすべて冪等性キーが付きます。ネットワークエラーやサーバーエラーはバックオフ付きで再試行され、再試行した送信が再び課金されることはありません。
1回の呼び出しでアップロード
データURLには大きすぎるファイルは署名付きアップロードで送信。チケットの取得、PUT、サイズの確認はSDKが処理します。
わかりやすいエラー
APIに拒否された場合は、HTTPステータス、エラーコード、リクエストIDが付きます。生成の失敗やキャンセル、タイムアウトには、それぞれ専用のエラー型があります。
パッケージ
入手先
| SDK | パッケージ | インストール | ソース |
|---|---|---|---|
| TypeScript SDK | @mage-space/sdk | npm install @mage-space/sdk | GitHub |
| Python SDK | mage-space | pip install mage-space | GitHub |
| ComfyUI向けMage | comfyui-mage | comfy node install comfyui-mage | GitHub |
FAQ
よくある質問
Mage SDKは無料のオープンソースですか?
Mageの新しいモデルは古いSDKでも使えますか?
SDKは、リトライしたリクエストの二重課金をどう防いでいますか?
SDKは安定していますか?
Mage API の料金はいくらですか?
API を使うには Mage のメンバーシップが必要ですか?
API で生成したものは商用利用できますか?
Mageで開発を始めよう
アカウントはひとつ、Gemsの残高もひとつで、すべてのモデルが使えます。料金は生成した分だけです。