模型 API 接入文档
Runway API 接入文档
通过 Rivya Public API v1 调用 Runway,包含模型 ID runway、输入类型、参数、Files API 规则、积分和响应示例。
API 可调用文本或 URL 可用;参考模式使用 Files API视频
API 模型 ID
runway
输入类型
text, file
Files API
参考素材模式需要
基础积分
12
能力类型
视频
计费方式
FIXED
提示词上限
1800 字符
请求字段
模型 ID 放在顶层字段。模型专属控制项放入 params。
| Key | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| model | string | 是 | runway | 使用 runway 作为 API 模型 ID。 |
| prompt | string | 是 | - | 这个模型最多 1800 个字符。 |
| params | object | 否 | - | 模型专属参数对象。可用 key 见下方参数表。 |
| client_request_id | string | 否 | - | 可选客户端请求 ID,便于你在自己的系统中追踪请求。 |
模型参数
| Key | 类型 | 必填 | 默认值 | 范围 | 枚举值 | 说明 |
|---|---|---|---|---|---|---|
| duration | select | 否 | 5 | - | 5, 10 | 视频时长 |
| quality | select | 否 | 720p | - | 720p, 1080p | 视频分辨率 |
| aspectRatio | select | 否 | 16:9 | - | 16:9, 4:3, 1:1, 3:4, 9:16 | 宽高比 |
| waterMark | text | 否 | - | - | - | 视频水印 |
上传策略
先上传参考文件,再把返回的 URL 和 durationToken 放入 params.referenceMediaItems。
参考素材规则
参考图片: 可选上传 1 张图片切换到图生视频;不上传图片时继续走文生视频。
最大文件数
1
支持文件类型
image
Duration token
视频和音频参考素材需要时长校验时,应携带 /api/v1/files 返回的 durationToken。
| kind | 大小上限 | MIME 类型 |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
最小请求
{
"model": "runway",
"prompt": "A cinematic product reveal with smooth camera movement",
"params": {
"duration": "5",
"quality": "720p",
"aspectRatio": "16:9",
"waterMark": "留空表示不添加水印"
}
}参考文件请求
{
"model": "runway",
"prompt": "A cinematic product reveal with smooth camera movement",
"params": {
"duration": "5",
"quality": "720p",
"aspectRatio": "16:9",
"waterMark": "留空表示不添加水印",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}创建响应
创建接口会返回公开任务 ID。继续轮询状态接口,直到任务成功或失败。
{
"id": "task_runway_example",
"status": "queued",
"model": "runway",
"reserved_credits": 12,
"final_credits": 0,
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}常见错误
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
部分模式需要通过 Files API 上传参考素材。