Generate video clip
generate_video_clipCreate a video clip from a text prompt, source images, videos, spoken dialogue, or reference audio, with optional quality and aspect ratio.
Instructions
Generate a video clip from a text prompt, source images, source videos, spokenDialogue, or reference audio. quality is optional (LOW, STANDARD, HIGH, or MAX). Typically takes 1–3 minutes (HIGH/MAX can be longer). Tell the user that wait up front and keep polling calmly.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "generate_video_clip"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | No | Description of the video to generate. | |
| quality | No | Video generation quality. Omit to use workspace settings. | |
| aspectRatio | No | Output aspect ratio as width:height units (not pixels). Example: { width: 16, height: 9 }. | |
| audioFileIds | No | Optional reference audio file ids used to lip-sync from a recording. Use spokenDialogue to have the model speak a line it generates itself. | |
| imageFileIds | No | Optional reference image file ids. | |
| videoFileIds | No | Optional reference video file ids. | |
| generateAudio | No | Whether the result must include generated audio. | |
| spokenDialogue | No | Exact line the subject should speak as native lip-synced speech. The model synthesizes the voice from this text. | |
| durationSeconds | No | Optional clip length in whole seconds (1 to 30). Omit or pass null for Auto. | |
| startFrameFileId | No | Optional opening-frame still file id. Used as the first frame of the clip. | |
| voiceDescription | No | Natural-language description of the voice that speaks spokenDialogue. Used when spokenDialogue is set. | |
| suppressBackgroundMusic | No | When true, the clip will not include a musical soundtrack. Spoken dialogue and environmental sound are still allowed. Use this when background music will be added separately. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Error details when status is failed; otherwise null. | |
| status | No | Job status: pending, running, succeeded, failed, or cancelled. | |
| results | No | Generated results with download URLs when succeeded. | |
| toolType | No | Tool name (e.g. GENERATE_IMAGE). | |
| attemptIndex | No | Current or latest attempt index. | |
| toolExecutionId | Yes | Tool execution id (vg_tool_...). | |
| progressPercentage | No | Completion progress 0-100 (present after polling). |