Back to Details

rw-fetch-api-reference

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Fetch Latest API Reference

获取最新API参考文档

Before guiding or implementing any Runway API integration, retrieve the current API reference and use it as the source of truth.
在指导或实现任何Runway API集成之前，请获取当前的API参考文档并将其作为事实来源。

Why This Matters

为什么这很重要

The Runway API is the official reference. Models, endpoints, request/response shapes, and versioning can change. Using the live docs ensures integration guidance and code match the latest API.
Runway API是官方参考文档。模型、端点、请求/响应结构以及版本规则可能会发生变化。使用在线文档可确保集成指导和代码与最新API保持一致。

Steps

步骤

1. Fetch the API Reference

1. 获取API参考文档

Retrieve the contents of:
https://docs.dev.runwayml.com/api/
Use your available fetch tool (e.g. 
mcp_web_fetch
or equivalent) to load this URL. The page contains the full API reference: endpoints, request bodies, accepted values, and examples.
获取以下链接的内容：
https://docs.dev.runwayml.com/api/
使用可用的抓取工具（例如
mcp_web_fetch
或同类工具）加载该URL。页面包含完整的API参考：端点、请求体、可接受的值以及示例。

2. Use It Before Integrating

2. 集成前使用该文档

  • Before writing or suggesting integration code for video, image, audio, uploads, characters, documents, or any other Runway API feature, use the fetched content as the authoritative reference.
  • Prefer exact endpoint paths, model IDs, parameter names, and header values from the fetched reference over any cached or local documentation.
  • If the fetched content conflicts with text in other skills (e.g. 
    +rw-api-reference
    or an integrate skill), the fetched docs take precedence for that session.
  • 在编写或建议针对视频、图像、音频、上传、角色、文档或任何其他Runway API功能的集成代码之前，请将抓取到的内容作为权威参考。
  • 优先使用抓取到的参考文档中的精确端点路径、模型ID、参数名称和头值，而非任何缓存或本地文档。
  • 如果抓取到的内容与其他技能（例如
    +rw-api-reference
    或集成技能）中的文本存在冲突，本次会话以抓取到的文档为准。

3. When to Re-Fetch

3. 何时重新抓取

  • Re-fetch when the user asks to integrate a new capability or when you are unsure about an endpoint or parameter.
  • Re-fetch when the user reports errors that might be due to API changes (e.g. invalid model name, changed request shape).
  • 当用户要求集成新功能，或者你对某个端点或参数不确定时，重新抓取文档。
  • 当用户报告可能由API变更导致的错误（例如无效模型名称、请求结构变更）时，重新抓取文档。

After Fetching

抓取完成后

Proceed with the relevant integrate skill (
+rw-integrate-video
, 
+rw-integrate-image
, 
+rw-integrate-audio
, 
+rw-integrate-uploads
, 
+rw-integrate-characters
, 
+rw-integrate-documents
, 
+rw-integrate-character-embed
) using the retrieved reference to guide implementation.
使用检索到的参考文档指导实现，继续使用相关的集成技能（
+rw-integrate-video
、
+rw-integrate-image
、
+rw-integrate-audio
、
+rw-integrate-uploads
、
+rw-integrate-characters
、
+rw-integrate-documents
、
+rw-integrate-character-embed
）。

Important Notes

重要说明

  • Base URL for the API is 
    https://api.dev.runwayml.com
    .
  • All requests require 
    Authorization: Bearer <RUNWAYML_API_SECRET>
    and 
    X-Runway-Version: 2024-11-06
    (or the version stated in the fetched docs).
  • Do not rely solely on bundled or in-repo API summaries when the user is integrating; the live docs are the source of truth.
  • API的基础URL为
    https://api.dev.runwayml.com
    。
  • 所有请求均需包含
    Authorization: Bearer <RUNWAYML_API_SECRET>
    和
    X-Runway-Version: 2024-11-06
    （或抓取文档中指定的版本）。
  • 当用户进行集成时，不要仅依赖捆绑或仓库内的API摘要；在线文档才是事实来源。