↓
Rivya AI Docs
Model API guides

Volcengine Video Lip Sync API reference

Check Volcengine Video Lip Sync availability, inputs, parameters, file requirements, credit pricing, and request examples for Rivya Public API v1. Model ID: volcengine-video-lip-sync.

Available via APIAPI statusVideo
API model ID

volcengine-video-lip-sync

Inputs

file

Files API

Required for reference modes

Credit pricing

Credit rate: 8 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
modelstringYesvolcengine-video-lip-syncSet model to volcengine-video-lip-sync.
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
modeselectYeslite-lite, basicLite fits front-facing single-person footage; Basic supports more complex single-person scenes.
separate_vocalselectNofalse-false, trueEnable vocal separation when the target audio includes background sound that should be suppressed.
open_scenedetselectNofalse-false, trueAvailable only in Basic mode for scene segmentation and speaker identification.
align_audioselectNotrue-true, falseAvailable only in Lite mode. Loop the video when the audio is longer than the source footage.
align_audio_reverseselectNofalse-false, trueAvailable only in Lite mode and requires audio alignment to be on.
templ_start_secondsnumberNo0min 0-Available only in Lite mode. Choose a non-negative start time in the source video.

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

Source video and target audio: Upload exactly one MP4 or MOV video up to 95 MB and one MP3, M4A, WAV, AAC, or OGG vocal track up to 10 MB.

Max files

2

Accepted file kinds

video, audio

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
video95 MBvideo/mp4, video/quicktime
audio10 MBaudio/mpeg, audio/mp4, audio/wav, audio/x-wav, audio/aac, audio/ogg

No runnable Public API example is shown for this model.

Reference-file request

{
  "model": "volcengine-video-lip-sync",
  "params": {
    "mode": "lite",
    "separate_vocal": "false",
    "open_scenedet": "false",
    "align_audio": "true",
    "align_audio_reverse": "false",
    "templ_start_seconds": 0,
    "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",
        "width": 1280,
        "height": 720,
        "sizeBytes": 8388608,
        "framesPerSecond": 30,
        "videoBitrateMbps": 8,
        "videoMetadataToken": "video_metadata_token_from_original_files_api_upload_response"
      },
      {
        "url": "https://cdn.example.com/reference-audio.wav",
        "kind": "audio",
        "name": "reference-audio.wav",
        "mimeType": "audio/wav",
        "durationSeconds": 12,
        "durationToken": "audio_duration_token_from_files_api"
      }
    ]
  }
}

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_volcengine_video_lip_sync_example",
  "status": "queued",
  "model": "volcengine-video-lip-sync",
  "reserved_credits": 8,
  "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.