关于 fetch-api-reference
这项工作流技能要求 Agent 在指导或实现 Runway API 集成前获取最新 API 参考,并以在线文档为端点、模型、参数和版本信息的依据。
主要功能
- 01获取在线 Runway API 参考
- 02以最新文档作为集成依据
- 03优先采用准确路径和参数值
- 04说明何时需要重新获取参考
适用场景
- 01准备 Runway API 集成
- 02编码前核对端点或参数
- 03排查可能由 API 变更导致的错误
- 04处理在线文档与内置摘要冲突
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ runwayml/ skills --skill fetch-api-reference安装后在 Claude Code 中输入/fetch-api-reference确认已加载。
详细介绍
获取最新 API 参考文档
在指导或实现任何 Runway API 集成之前,请先获取当前的 API 参考文档,并将其作为事实依据。
为什么这很重要
Runway API 是官方参考文档。模型、端点、请求/响应格式和版本都可能发生变化。使用实时文档可确保集成指南和代码与最新 API 一致。
步骤
1. 获取 API 参考文档
获取以下页面的内容:
https://docs.dev.runwayml.com/api/
使用可用的获取工具(例如 mcp_web_fetch 或同类工具)加载此 URL。该页面包含完整的 API 参考文档:端点、请求正文、可接受的值和示例。
2. 集成前先查阅
- 在编写或建议用于视频、图像、音频、上传、角色、文档或任何其他 Runway API 功能的集成代码之前,请使用获取的内容作为权威参考。
- 相较于任何缓存或本地文档,优先采用获取的参考文档中准确的端点路径、模型 ID、参数名称和标头值。
- 如果获取的内容与其他技能中的文本(例如
+api-reference或某个集成技能)冲突,本次会话以获取的文档为准。
3. 何时重新获取
- 用户要求集成新功能,或你不确定端点或参数时,请重新获取。
- 用户报告的错误可能由 API 变更导致时(例如模型名称无效、请求格式变更),请重新获取。
获取后
使用检索到的参考文档指导实现,并继续使用相关集成技能(+integrate-video、+integrate-image、+integrate-audio、+integrate-uploads、+integrate-characters、+integrate-documents、+integrate-character-embed)。
重要说明
- API 的基础 URL 为
https://api.dev.runwayml.com。 - 所有请求都必须包含
Authorization: Bearer <RUNWAYML_API_SECRET>和X-Runway-Version: 2024-11-06(或获取的文档中注明的版本)。 - 用户进行集成时,不要仅依赖随附或仓库内的 API 摘要;实时文档才是事实依据。
评论
支持 Markdown