↓
Rivya AI Docs
Model API guides

Rivya Video Upscale API reference

Check Rivya Video Upscale availability, inputs, parameters, file requirements, credit pricing, and request examples for Rivya Public API v1. Model ID: video-upscale.

Available via APIAPI statusVideo
API model ID

video-upscale

Inputs

file

Files API

Required for reference modes

Credit pricing

Credit rate: 1.5–6 per second of input The final cost is rounded up to whole credits.

Capability

Video

Billing

METERED

Prompt limit

No documented prompt limit

Request fields

Set model at the top level. Put model-specific controls and reference inputs in params, using the format documented for this model.

KeyTypeRequiredDefaultDescription
modelstringYesvideo-upscaleSet model to video-upscale.
promptstringNo-Prompt text for models that support text input.
paramsobjectYes-The model-specific params object. Use the documented keys and reference-file format for this model.
client_request_idstringNo-Optional ID for tracing this request in your system. It does not replace Idempotency-Key.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
resolutionselectNo2K-1080P, 2K, 4KResolution

Upload policy

Upload reference files through Files API first. Keep the original URLs, verified metadata, and tokens. Follow this model's request example: some models use params.referenceMediaItems, while others use different fields.

Reference rule

Reference files: Upload MP4, MOV or WebM up to 50 MB and 60 seconds. The output fits the chosen box without cropping; larger sources may be reduced. The operation preserves the source audio, frame rate and frame count.

Max files

1

Accepted file kinds

video

Duration token

When duration verification is required, use duration_token from /api/v1/files as durationToken in the request. Keep any additional signed metadata this model requires.

kindMax sizeMIME types
video48 MBvideo/mp4, video/quicktime, video/webm

No runnable Public API example is shown for this model.

Reference-file request

{
  "model": "video-upscale",
  "params": {
    "resolution": "2K",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-video.mp4",
        "kind": "video",
        "name": "reference-video.mp4",
        "mimeType": "video/mp4",
        "durationSeconds": 8,
        "durationToken": "video_duration_token_from_files_api",
        "sizeBytes": 8388608,
        "width": 1280,
        "height": 720,
        "framesPerSecond": 30,
        "videoBitrateMbps": 8,
        "videoMetadataToken": "video_metadata_token_from_original_files_api_upload_response"
      }
    ]
  }
}

Example response

An accepted generation request returns a task ID. Poll the status endpoint until the task succeeds or fails. A status request failure does not mean generation failed.

{
  "id": "task_video_upscale_example",
  "status": "queued",
  "model": "video-upscale",
  "reserved_credits": 1,
  "final_credits": 0,
  "settlement_status": "RESERVED",
  "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.