mcpField
R
rw-setup-api-key

rw-setup-api-key

github.com/runwayml開発74240 回インストール2 日前に更新
リポジトリ

rw-setup-api-key について

Runway APIキーの取得、SDKのインストール、プロジェクト設定を開発者向けに案内するガイドです。キーの管理、サーバーサイドでの呼び出し、クレジット要件、設定確認を扱います。

主な機能

  1. 01Runway APIキーの作成手順
  2. 02Node.jsとPython SDKのインストール方法
  3. 03RUNWAYML_API_SECRET環境変数の設定
  4. 04キーと.envファイルをソース管理から除外
  5. 05API設定とクレジット残高の確認

活用シーン

  1. 01既存プロジェクトでRunway APIを有効化
  2. 02Node.jsまたはPythonプロジェクトにSDKを設定
  3. 03認証情報を環境変数に安全に保存
  4. 04サーバーサイドのAPI認証設定を検証

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/runwayml/skills --skill rw-setup-api-key

インストール後、Claude Code で/rw-setup-api-keyを入力して読み込まれたか確認します。

詳細

API キーの設定

Runway API キーの取得、SDK のインストール、API アクセスのためのプロジェクト設定をユーザーに案内します。

前提条件： まず +rw-check-compatibility を実行し、プロジェクトがサーバーサイド機能に対応していることを確認してください。

手順 1：Runway デベロッパーアカウントを作成する

ユーザーに以下を案内してください。

  1. https://dev.runwayml.com/ にアクセスします
  2. 組織を作成します（または既存の組織を使用します）
  3. Organization Settings → API Keys に移動します
  4. Create API Key をクリックします
  5. キーをすぐにコピーします — キーが表示されるのは一度だけで、後から復元できません

ユーザーに伝える重要な注意事項：

  • 紛失したキーは取得できません。紛失した場合は、古いキーを無効化して新しいキーを作成してください。
  • API キーはユーザー単位ではなく、組織単位で管理されます。
  • API を使用するには、事前にクレジットを購入する必要があります。最低購入額は**$10**（0.01 ドル／クレジットで 1,000 クレジット）です。https://dev.runwayml.com/ の Billing から購入してください。

手順 2：SDK をインストールする

Node.js
npm install @runwayml/sdk

Node.js 18+ が必要です。SDK には TypeScript の型定義が含まれています。

Python
pip install runwayml

Python 3.8+ が必要です。MyPy の型アノテーションが含まれています。

手順 3：環境変数を設定する

SDK は RUNWAYML_API_SECRET 環境変数から API キーを自動的に読み込みます。

オプション A：.env ファイル（開発時に推奨）

プロジェクトに .env ファイルがすでにあるか確認してください。ある場合は追記し、ない場合は新しく作成します。

RUNWAYML_API_SECRET=your_api_key_here

Node.js プロジェクトの場合： プロジェクトで .env ファイルが読み込まれることを確認します。

  • Next.js、Remix、Vite — .env を標準でサポートしているため、追加の設定は不要です
  • Express／Fastify／素の Node — dotenv をインストールします。 
    npm install dotenv
    エントリーポイントに追加します。 
    import 'dotenv/config';

Python プロジェクトの場合： 標準でサポートされているフレームワークを使用しない場合は、python-dotenv がインストールされていることを確認します。

pip install python-dotenv

エントリーポイントに追加します。

from dotenv import load_dotenv
load_dotenv()
オプション B：システム環境変数
export RUNWAYML_API_SECRET=your_api_key_here
オプション C：クライアントに直接渡す（非推奨）
// Node.js
const client = new RunwayML({ apiKey: 'your_api_key_here' });

# Python
client = RunwayML(api_key='your_api_key_here')

ユーザーに警告してください： キーをソースコードに直接記述しないでください。環境変数またはシークレットマネージャーを使用してください。

手順 4：.gitignore を更新する

API キーを誤ってコミットしないよう、.env が .gitignore に含まれていることを確認してください。

.env
.env.local
.env.*.local

既存の .gitignore を確認し、該当する記述がない場合は追加してください。

手順 5：設定を確認する

簡単な確認を実行するよう、ユーザーに提案してください。

Node.js
import RunwayML from '@runwayml/sdk';

const client = new RunwayML();
// If no error is thrown, the API key is configured correctly
console.log('Runway SDK initialized successfully');
Python
from runwayml import RunwayML

client = RunwayML()
# If no error is thrown, the API key is configured correctly
print('Runway SDK initialized successfully')

手順 6：クレジット残高を確認する

ユーザーに以下を伝えてください。

  • API を使用するには、前払いクレジットが必要です
  • 最低購入額：$10（1,000 クレジット）
  • 購入先：https://dev.runwayml.com/ → Billing
  • API 経由で残高を確認できます。
// Node.js - check organization info
const response = await fetch('https://api.dev.runwayml.com/v1/organization', {
  headers: {
    'Authorization': `Bearer ${process.env.RUNWAYML_API_SECRET}`,
    'X-Runway-Version': '2024-11-06'
  }
});
const org = await response.json();
console.log('Credits:', org.creditBalance);

セキュリティチェックリスト

次に進む前に、以下を確認してください。

  • API キーはソースコードに直接記述せず、環境変数に保存されている
  • .env ファイルが .gitignore に含まれている
  • API 呼び出しはサーバーサイドでのみ実行される（ブラウザーで実行されるコードからは呼び出されない）
  • ユーザーがクレジットを購入済みである

次のステップ

API キーの設定後、ユーザーは以下の連携に進めます。

  • +rw-integrate-video — 動画生成（テキストから動画、画像から動画）
  • +rw-integrate-image — 画像生成
  • +rw-integrate-audio — 音声生成（TTS、効果音、音声）
  • +rw-integrate-uploads — 画像／動画入力を必要とするモデル向けのファイルアップロード

コメント

Markdown 対応