API 参考

开始生成

从图像生成视频

POST /v1/image_to_video
该端点将启动一项新任务，根据图像提示生成视频。

Authorization

将 HTTP Authorization 标头与Bearer方案以及 API 密钥一起使用。

Headers

X-Runway-Version 需的
必须将此字段设置为精确的值 2024-11-06

请求正文Request body

promptImage
必需的
PromptImages 的字符串或数组（对象）
字符串 < uri >
包含要用作生成视频第一帧的编码图像的 HTTPS URL 或数据 URI。有关更多信息，请参阅我们的图像输入文档。

对象数组
表示要在输出视频中使用的图像的对象数组。任何两个提供的图像都不能具有相同的position值。

uri
必需的
string
< URI >
包含编码图像的 HTTPS URL 或数据 URI。有关更多信息，请参阅有关图像输入的文档。

position
必需的
string
接受的值：
“第一的”
“最后的”
输出视频中图像的位置。“first”将使用图像作为视频的第一帧，“last”将使用图像作为视频的最后一帧。

model
必需的
string
接受的值：
“gen3a_turbo”
要使用的模型变体。

seed
整数
[0...4294967295]
如果未指定，则选择随机数。改变种子整数是一种针对相同其他请求参数获得不同结果的方法。对相同请求使用相同的种子整数将产生类似的结果。

promptText
string
<= 512 个字符
长度最多为 512 个 UTF-16 代码点的非空字符串（即promptText.length === 512JavaScript 中的字符串）。这应该详细描述输出中应出现的内容。

watermark
布尔值
默认：
错误的
一个布尔值，指示输出视频是否包含 Runway 水印。

duration
整数
默认：
10
接受的值：
5
10
输出视频的持续秒数。

ratio
string
接受的值：
“1280:768”
“768:1280”
输出视频的分辨率。

响应
200
任务已成功创建。

响应架构：application/json
id
必需的
string
<唯一标识号>
新创建任务的ID。使用此ID可以查询任务状态并检索生成的视频。

429
您已超出此端点的速率限制。

获取任务详细信息

GET /v1/tasks/{id}
返回有关任务的详细信息。此 API 的使用者不应期望给定任务的更新频率高于每五秒一次。

验证
Authorization
将 HTTPAuthorization标头与Bearer方案以及 API 密钥一起使用。

路径参数
id
必需的
string
<唯一标识号>
之前已提交且还未被取消或删除的任务的ID。

标头
X-Runway-Version
必需的
string
必须将此字段设置为精确的值2024-11-06。

响应
200
任务状态。

响应架构：application/json

id
string
<唯一标识号>
正在返回的任务的 ID。

status

"RUNNING"
"SUCCEEDED"
"FAILED"
"PENDING"
"CANCELLED"
"THROTTLED"

PENDING tasks have been enqueued and are waiting to run.
THROTTLED tasks are waiting to be enqueued until other jobs have finished running.
RUNNING tasks are currently being processed.
SUCCEEDED tasks have completed successfully.
FAILED tasks have failed.
CANCELLED tasks have been aborted.

createdAt
string
<日期时间>
提交任务的时间戳。

failure
string
如果状态为FAILED，这将包含一个人性化的失败原因。

failureCode
string
如果任务的状态为FAILED，则包含机器可读的错误代码。这是一个以点分隔的字符串，最左边的部分是最通用的，最右边的部分是最具体的。例如，SAFETY.INPUT.TEXT表示由于输入文本的内容审核错误，任务失败。

output
数组
字符串
< URI >
[ 项目< uri > ]
如果状态为SUCCEEDED，则将包含一个字符串数组。每个字符串都是一个返回任务输出的 URL。URL 将在 24-48 小时内过期；再次获取任务以获取新的 URL。希望您下载这些 URL 上的资产并将其存储在您自己的存储系统中。

progress
数字
如果任务的状态为RUNNING，它将包含一个介于 0 和 1 之间的浮点数，表示生成的进度。

404
该任务不存在、已被删除或取消。