REST API ReferenceEndpointsTools

Generate avatar clip

Generate a talking-head avatar video by pairing a presenter with an audio file, typically from a prior text-to-speech result.

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.
avatarPresenterIdstringRequired

Presenter id from GET /v1/resources/avatar-presenters.

audioStorageFileIdstringRequired

File id of an AUDIO file (e.g. vg_file_...), typically from a prior text-to-speech result. Upload a file first via POST /v1/files/upload or generate one with POST /v1/tools/text-to-speech, then pass the returned id here.

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_...).