Back to Details

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. 
    +api-reference
    or an integrate skill), the fetched docs take precedence for that session.
  • 在为视频、图像、音频、上传、角色、文档或任何其他Runway API功能编写或建议集成代码之前，请将获取到的内容作为权威参考。
  • 优先使用获取到的参考中的准确端点路径、模型ID、参数名称和标头值，而非任何缓存或本地文档。
  • 如果获取到的内容与其他技能中的文本（例如
    +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 (
+integrate-video
, 
+integrate-image
, 
+integrate-audio
, 
+integrate-uploads
, 
+integrate-characters
, 
+integrate-documents
, 
+integrate-character-embed
) using the retrieved reference to guide implementation.
使用获取到的参考作为实施指导，继续执行相关的集成技能（
+integrate-video
、
+integrate-image
、
+integrate-audio
、
+integrate-uploads
、
+integrate-characters
、
+integrate-documents
、
+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摘要；实时文档才是事实依据。