Rivya AI Docs

Wan Animate Replace API Integration

Use Wan Animate Replace through Rivya Public API v1 with model id wan-2-2-animate-replace, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIURL input readyVideo
API model id

wan-2-2-animate-replace

Inputs

url

Files API

Not required for the minimal request

Base credits

20

Capability

Video

Billing

FIXED

Prompt limit

No documented prompt limit

Request contract

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

KeyTypeRequiredDefaultDescription
modelstringYeswan-2-2-animate-replaceUse the wan-2-2-animate-replace API model id.
promptstringNo-Prompt text for models that support text input.
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
video_urltextNo---Paste a public video URL that the generation service can fetch directly. This model expects a hosted asset such as MP4, MOV, or MKV, not a local upload path.
image_urltextNo---Paste a public replacement image URL. JPEG, PNG, or WebP work best; when the aspect ratio differs, the upstream service will scale and center-crop it.
resolutionselectNo480p-480p, 580p, 720pCurrent tiers are `480p`, `580p`, and `720p`. Higher output tiers usually mean higher credit cost and longer waits.

Minimal request

{
  "model": "wan-2-2-animate-replace",
  "params": {
    "video_url": "https://example.com/input.mp4",
    "image_url": "https://example.com/reference.png",
    "resolution": "480p"
  }
}

Create response

The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.

{
  "id": "task_wan_2_2_animate_replace_example",
  "status": "queued",
  "model": "wan-2-2-animate-replace",
  "reserved_credits": 20,
  "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

This model accepts public URL input through model parameters.