API protocol
Runway: parameters, scenarios and API guide
Preview guide
Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.
Direct answerThe official OpenAPI does not list runway-vip-video; its mapping to gen4.5/gen4_turbo is unverified. Fields below describe official Gen-4.5 text/image generation only, not executable site-alias requests. Examples remain withdrawn.
Updated · Reviewed
Purpose and workflows
The catalog includes runway-vip-video without a callable endpoint definition in the current public listing. Official Gen requests or generic video fields cannot be assumed to work here.
This guide checks the site request contract; it does not claim paid generation acceptance for every scenario. Use the exact model, group and available endpoint shown in the marketplace. Replace example.com media and placeholder task IDs. Confirm a minimal request before adding references and advanced parameters. Consult marketplace pricing and actual billing for charges.
Models and endpoints
runway-vip-video
This family has no published executable site generation request here. The guide retains selection and migration information; a catalog entry is not endpoint acceptance.
Reference media formats
| Media | Fields | Encoding and transport | Preparation and limits |
|---|---|---|---|
| Images / frames | — | No executable site media-input contract is published for this family. Do not infer URL/Base64 support from official or other-family APIs. | Confirm the exact model and available endpoint. Disk paths, data URIs, raw Base64 and task IDs are not interchangeable. |
| Reference / edit video | — | No executable site media-input contract is published for this family. Do not infer URL/Base64 support from official or other-family APIs. | Confirm the exact model and available endpoint. Disk paths, data URIs, raw Base64 and task IDs are not interchangeable. |
| Reference audio | — | No executable site media-input contract is published for this family. Do not infer URL/Base64 support from official or other-family APIs. | Confirm the exact model and available endpoint. Disk paths, data URIs, raw Base64 and task IDs are not interchangeable. |
Parameters and combinations
- The official OpenAPI does not list runway-vip-video; its mapping to gen4.5/gen4_turbo is unverified. Fields below describe official Gen-4.5 text/image generation only, not executable site-alias requests. Examples remain withdrawn.
- Accepted unified video examples are not currently published. Review the family and requirements without inventing endpoints/model suffixes or restoring withdrawn Remix examples.
- Confirm the exact marketplace model, effective endpoint, group access and task response. Acceptance does not mean a finished video.
- Verify text generation, image input, output settings and terminal status before independently testing editing, extension, sound and multiple references.
| Field | Type | Use and constraints |
|---|---|---|
model | official string | Gen-4.5 uses gen4.5. Other models differ; runway-vip-video is not a listed official ID. |
promptText | official string | Required for Gen-4.5, 1–1000 UTF-16 code units; not an established site prompt mapping. |
promptImage | official string / object[] | Required for image generation: HTTPS, runway:// upload URI or image data URI. Frame objects use uri and position under the model schema. Site alias support is unverified. |
duration | official integer | Required for Gen-4.5, 2–10s; not a site-alias duration guarantee. |
ratio | official string | Required Gen-4.5 pixel ratio such as 1280:720, not 16:9. Text has landscape/portrait; image adds square and other sizes. Follow the official schema. |
seed | official integer | Optional, 0–4294967295, random if omitted; site alias support unverified. |
contentModeration.publicFigureThreshold | official string | Optional auto/low, affects official public-figure moderation; not established as exposed here. |
outputFormat | official string | Optional, default mp4; official ProRes, PNG sequence and HDR/EXR exports have distinct delivery and charges. Consult the schema; not established as exposed here. |
proresProfile | official string | Only for relevant ProRes output; allowed profiles/defaults depend on outputFormat. Not established as exposed here. |
X-Runway-Version | official header | Required official version header; adding it does not make the site alias compatible with the official API. |
Scenarios and code examples
Check whether the exact model has an available endpoint and a published parameter contract. Verify minimal text input, a single image, output settings and terminal task results in that order. Do not construct model suffixes from another platform, or reuse another family’s prompt/content/contents schema. Unpublished scenarios have no submit action or executable sample.
Task results and downloads
Save id or task_id from submission. Poll GET /v1/videos/{task_id}: queued / in_progress lead to completed or failed. Read video_url on completion (some responses also expose metadata.url). Resolve relative URLs against the API origin. The site /content endpoint uses your site key; external downloads must not receive that key. Download expiring results promptly. Resume GET after a timeout rather than automatically repeating POST.
Complete unified video Python / JavaScript polling and download examples
Troubleshooting
| Symptom | Check |
|---|---|
| Image validation / URI error | Ensure a video or task ID was not placed in an image field; check the URL returns media |
| Unsupported content type / field | Check the exact family and content/contents/input schema; voice_id cannot be an audio URL |
| 400 conflicting fields | Check prompt/input, frames/references, and seconds/response_format exclusivity |
| HTTP success but task failed | Retain the site task ID, time, model, domain and redacted request; submission 200 is not output success |
| 404 or inaccessible task | Check domain, key access and task type; do not use IDs from another site or the official API |
| Local file cannot be fetched | Use a supported upload flow or a reachable HTTPS media URL |
Sources and scope
Use cases
- Choose video models and media formats
- Diagnose request and task failures
API protocols
/v1/models
FAQ
Does a task ID prove generation succeeded?
No. Save the site task ID, poll to a successful terminal state and verify the result. Inspect failures instead of automatically creating a new task.
Can I put a local image, video or WAV path in JSON?
No. URL fields require reachable media, not localhost, disk paths or browser-login links. Kling PCM WAV requires an enabled multipart voice endpoint (both sites returned 404 on 2026-11-15). Follow each family’s asset workflow for other media.
Can parameters and task IDs be reused across models?
Do not assume compatibility. Check the exact model, endpoint, casing, media role and exclusive fields. Editing, drafts and voices require accessible successful tasks of the correct kind. Official capabilities are not evidence of site acceptance.
Related guides
Official sources
- Runway OpenAPI schema Official
- Runway API guide Official
兔子API