Generate video
vivid_generate_videoStart a video generation on VIVID from a prompt by specifying a model and duration; it returns a job ID for polling status until the clip is ready.
Instructions
Start a video generation on VIVID. Pick a model with vivid_list_models (type=video) and respect its durations / resolutions / aspect ratios. Reference images, start/end frames and audio must be public URLs (use vivid_upload_file for local files). Credits are pre-charged (credits/second × duration). Videos take 1-5 minutes: by default this returns the jobId immediately — poll with vivid_job_status. Note: a model's start/end frame and reference images can be mutually exclusive (e.g. Seedance 2.5): the backend resolves it and returns a warning. Reference videos (referenceVideoUrls) work on models whose vivid_list_models entry has referenceVideos: Seedance 2.0/2.5 bill the uploaded seconds too, Gemini Omni takes one source clip.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Model mode when applicable (e.g. "std" | "pro" for Kling O3). | |
| wait | No | Block until the video is ready (polls up to timeoutSec). Prefer false + vivid_job_status for long clips. | |
| model | Yes | Video model slug, e.g. "seedance-2.5", "kling-o3", "minimax-h3". | |
| prompt | Yes | Shot description. Describe subject, action, camera, lighting; keep camera and subject movement in separate sentences. | |
| duration | Yes | Seconds — must be one of the model's supported durations. | |
| projectId | No | ||
| resolution | No | e.g. "480p" | "720p" | "1080p" when the model supports it. Defaults to the model default (usually 720p). | |
| timeoutSec | No | ||
| aspectRatio | No | 16:9 | |
| endFrameUrl | No | Last frame (needs startFrameUrl on most models). | |
| audioFileUrls | No | Audio files: voice for talking-head models, or reference audio where supported. | |
| generateAudio | No | Native audio (dialogue / SFX) when the model supports it. | |
| startFrameUrl | No | Image-to-video first frame. Gallery images (download URLs from VIVID) work as they are. | |
| referenceImageUrls | No | Subject / product reference images (models with "reference" support). | |
| referenceVideoUrls | No | Reference videos (MP4/MOV) to copy motion, rhythm or framing from. Seedance 2.0: max 3, 15 s in all. Seedance 2.5: max 3, 2–30 s each, 30 s in all, 480p or 720p only (never with start/end frame). Gemini Omni: 1 clip, first 10 s. Billed seconds: see vivid_list_models. |