REST API ReferenceEndpointsTools

Generate video clip

Generate a video clip from a text prompt, optionally guided by reference images or an input video. At least one of prompt, imageFileIds, or videoFileId must be provided.

Authentication

AuthorizationBearer
API key from [app.videogen.io/developers](https://app.videogen.io/developers). The full key is only shown once when you create it.

Request

This endpoint expects an object.
promptstringOptional
Text prompt describing the video to generate. Optional when reference images or a video are provided.
imageFileIdslist of stringsOptional

Optional file ids of reference images (e.g. ["vg_file_..."]). Upload files first via POST /v1/files/upload, then pass the returned ids here. When provided, the model animates or uses these images as guidance.

videoFileIdstringOptional

Optional file id of a source video (e.g. vg_file_...). Upload a file first via POST /v1/files/upload, then pass the returned id here. When provided, the model restyles or transforms the input video.

generateAudiobooleanOptionalDefaults to false
When true, the generated video is guaranteed to include audio. When false, audio may still be present. Defaults to false.
aspectRatioobjectOptional

Aspect ratio for the generated video. Defaults to 16:9 when omitted.

watermarkModeenumOptionalDefaults to AUTO

Controls whether the VideoGen watermark is applied to the output. AUTO applies the watermark unless you have the Production API add-on. VIDEO_GEN always applies it. NONE removes the watermark — requires the Production API add-on; returns an error if you don’t have it.

Allowed values:
numResultsintegerOptional1-100Defaults to 1
Number of output results to generate. Defaults to 1.
isOutputTemporarybooleanOptionalDefaults to false

When true, generated files are temporary. Temporary files are guaranteed to be available for 24 hours, after which they may be archived at any time. Temporary files are not analyzed (no description, transcript, or embedding will be generated), so they will not appear in search results. Defaults to false.

Response

Execution accepted; poll until complete.

toolExecutionIdstring

Execution id (e.g. vg_exec_...).