setup-api-key

设置 API 密钥

指导用户获取 Runway API 密钥、安装 SDK，并配置项目以访问 API。

前置条件： 先运行 +check-compatibility，确保项目具备服务端能力。

第 1 步：创建 Runway 开发者账户

引导用户执行以下操作：

1. 前往 https://dev.runwayml.com/
2. 创建一个组织（或使用现有组织）
3. 前往 组织设置 → API 密钥
4. 点击 创建 API 密钥
5. 立即复制密钥——该密钥只会显示一次，无法恢复

务必告知用户以下重要事项：

• 丢失的密钥无法找回。如果密钥丢失，请停用旧密钥并创建新密钥。
• API 密钥的作用范围是组织级别，而非用户级别。
• API 开始运行前，必须预先购买额度。最低购买金额为 $10（1,000 个额度，每个额度 $0.01）。请前往 https://dev.runwayml.com/ 的账单页面购买。

第 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 项目： 如果未使用内置支持 .env 的框架，请确保已安装 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

确保 .env 位于 .gitignore 中，以防意外提交 API 密钥：

.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/ → 账单
• 用户可通过 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 密钥后，用户即可继续进行集成：

• +integrate-video — 视频生成（文本转视频、图像转视频）
• +integrate-image — 图像生成
• +integrate-audio — 音频生成（TTS、音效、语音）
• +integrate-uploads — 为需要图像/视频输入的模型上传文件