Rivya AI Docs

Runway API Integration

Use Runway through Rivya Public API v1 with model id runway, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIText or URL ready; reference modes use Files APIVideo
API model id

runway

Inputs

text, file

Files API

Required for reference modes

Base credits

12

Capability

Video

Billing

FIXED

Prompt limit

1800 characters

Request contract

Send the model id at the top level. Model-specific controls belong in params.

KeyTypeRequiredDefaultDescription
modelstringYesrunwayUse the runway API model id.
promptstringYes-Maximum 1800 characters for this model.
paramsobjectNo-Model-specific parameter object. Use the rows below for allowed keys.
client_request_idstringNo-Optional client-side id for tracing requests in your system.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
durationselectNo5-5, 10Duration
qualityselectNo720p-720p, 1080pQuality
aspectRatioselectNo16:9-16:9, 4:3, 1:1, 3:4, 9:16Aspect ratio
waterMarktextNo---Watermark

Upload policy

Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.

Reference rule

Reference image: Optionally upload one image to switch into image-to-video mode; leave it empty to stay in text mode.

Max files

1

Accepted file kinds

image

Duration token

Video and audio references should carry durationToken from /api/v1/files when duration verification is required.

kindMax sizeMIME types
image10 MBimage/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.