Runway API Integration
Use Runway through Rivya Public API v1 with model id runway, supported inputs, parameters, Files API rules, credits, and response examples.
runway
text, file
Required for reference modes
12
Video
FIXED
1800 characters
Request contract
Send the model id at the top level. Model-specific controls belong in params.
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | runway | Use the runway API model id. |
| prompt | string | Yes | - | Maximum 1800 characters for this model. |
| params | object | No | - | Model-specific parameter object. Use the rows below for allowed keys. |
| client_request_id | string | No | - | Optional client-side id for tracing requests in your system. |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| duration | select | No | 5 | - | 5, 10 | Duration |
| quality | select | No | 720p | - | 720p, 1080p | Quality |
| aspectRatio | select | No | 16:9 | - | 16:9, 4:3, 1:1, 3:4, 9:16 | Aspect ratio |
| waterMark | text | No | - | - | - | Watermark |
Upload policy
Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.
Reference image: Optionally upload one image to switch into image-to-video mode; leave it empty to stay in text mode.
1
image
Video and audio references should carry durationToken from /api/v1/files when duration verification is required.
| kind | Max size | MIME types |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
Minimal request
{
"model": "runway",
"prompt": "A cinematic product reveal with smooth camera movement",
"params": {
"duration": "5",
"quality": "720p",
"aspectRatio": "16:9",
"waterMark": "Leave empty to disable watermark"
}
}Reference-file request
{
"model": "runway",
"prompt": "A cinematic product reveal with smooth camera movement",
"params": {
"duration": "5",
"quality": "720p",
"aspectRatio": "16:9",
"waterMark": "Leave empty to disable watermark",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}Create response
The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.
{
"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
}Common errors
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
Some modes require Files API reference uploads.