mcpField
R
recipe-full-setup

recipe-full-setup

github.com/runwayml开发7446 次安装2 天前更新
代码仓库

关于 recipe-full-setup

recipe-full-setup 是将 Runway 公共 API 集成到应用中的引导式工作流，涵盖服务端兼容性检查、凭证配置、集成方案选择、代码实现和测试。

主要功能

  1. 01检查项目和运行时兼容性
  2. 02配置 API 凭证和 SDK
  3. 03按能力选择集成技能
  4. 04指导实现服务端 API
  5. 05测试集成并排查问题

适用场景

  1. 01为应用接入 Runway API 做准备
  2. 02为媒体生成计划选择相应技能
  3. 03实现并验证服务端 API 路由

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/runwayml/skills --skill recipe-full-setup

安装后在 Claude Code 中输入/recipe-full-setup确认已加载。

详细介绍

完整的 Runway API 设置

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

本方案将引导用户完成在项目中集成 Runway 公共 API 的完整流程，包括兼容性检查、API 密钥设置和 API 集成。

工作流

阶段 1：兼容性检查

使用 +check-compatibility 分析用户的项目。

  1. 确定项目类型（Node.js、Python 等）
  2. 验证是否具备服务端能力
  3. 检查运行时版本是否兼容
  4. 检查是否已安装 Runway SDK

如果项目不兼容，请停止并说明可选方案：

  • 添加后端（Express、FastAPI 等）
  • 使用全栈框架（Next.js、SvelteKit、Nuxt、Remix）
  • 添加无服务器函数（Vercel Functions、AWS Lambda）
  • 创建独立的后端服务

如果需要更改，请先协助用户完成所需更改，再继续。

如果兼容，请继续阶段 2。

阶段 2：API 密钥设置

使用 +setup-api-key 配置凭据。

  1. 引导用户前往 https://dev.runwayml.com/ 创建账户和 API 密钥
  2. 安装相应的 SDK（Node.js 使用 @runwayml/sdk，Python 使用 runwayml）
  3. 配置 RUNWAYML_API_SECRET 环境变量
  4. 更新 .gitignore，将 .env 排除在外
  5. 提醒用户需要购买额度（最低 $10）

等待用户确认已获取 API 密钥后再继续。

阶段 3：确定要集成的功能

询问用户想要构建什么。根据用户的回答，使用相应的集成技能：

用户想要……使用的技能
根据文本生成视频+integrate-video（文本生成视频）
将图像制作成动画视频+integrate-video（图像生成视频）；如果使用本地文件，则加上 +integrate-uploads
编辑／转换现有视频+integrate-video（视频生成视频）+ +integrate-uploads
根据文本生成图像+integrate-image
使用参考图像生成图像+integrate-image；如果使用本地参考图，则加上 +integrate-uploads
文本转语音+integrate-audio
音效+integrate-audio
语音隔离／配音+integrate-audio + +integrate-uploads
实时对话式虚拟形象+integrate-characters + +integrate-character-embed（React UI）
具有领域知识的虚拟形象+integrate-characters + +integrate-documents + +integrate-character-embed
多种功能分别集成各项功能，并共享同一个客户端实例
阶段 4：编写集成代码

根据用户使用的框架和需求：

  1. 创建 API 路由／处理程序 — 调用 Runway 的服务端端点
  2. 如果用户需要接收其用户上传的文件，添加上传处理
  3. 添加错误处理 — 捕获并处理任务失败
  4. 处理输出存储 — 提醒用户，输出 URL 会在 24-48 小时后过期
阶段 5：测试和验证

协助用户：

  1. 运行一次测试生成，验证一切正常
  2. 检查常见问题（缺少环境变量、额度不足、模型错误）
  3. 确认可以访问输出

上传需求决策树

当用户的工作流涉及将图像或视频用作输入时：

Does the input come from a public HTTPS URL?
├── YES → Pass the URL directly to the API
└── NO → Is it a local file or user-uploaded file?
    ├── YES → Use +integrate-uploads to upload first, then pass runway:// URI
    └── NO → Is it small enough for a data URI? (< 5MB image, < 16MB video)
        ├── YES → Convert to base64 data URI
        └── NO → Use +integrate-uploads

重要提醒

  • 切勿在客户端代码中暴露 API 密钥。 所有 API 调用都必须在服务端进行。
  • 输出 URL 会过期。 务必下载并保存生成的内容。
  • 需要使用积分。 没有预充值积分，API 将无法使用。
  • 存在速率限制。 存在速率限制。在尝试并发生成之前，务必先确认速率限制。
  • 输入和输出均受内容审核约束。 被安全机制标记的输入不予退款。
  • 注意成本。 帮助用户根据预算选择合适的模型。积分费用可在 https://docs.dev.runwayml.com/guides/pricing/ 中查看。

评论

支持 Markdown