VIvideogen
Tools

Generate avatar clip

Changed on

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

post/v1/tools/generate-avatar

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

Request body

actorEntityIdstring required

The id of a built-in stock actor or an ACTOR entity (e.g. vg_enti_...) with an image reference.

avatarQuality'LOW' | 'STANDARD' | 'HIGH' | 'MAX'

AI generation quality tier, shared across every generative feature (image, video, text, and so on). LOW is fastest and cheapest, STANDARD balances quality and cost, HIGH is higher quality, and MAX is the highest quality.

When a request omits the quality field, VideoGen falls back to your account's Default AI quality for that feature, which you can change at Account settings. Not every feature supports every tier; unsupported tiers are rejected with an error (see each field's description).

audioFileIdstring required

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.

watermarkMode'NONE' | 'VIDEO_GEN' | 'AUTO'

Controls whether the VideoGen watermark is applied to the output. AUTO applies the watermark unless you have a Pro plan. VIDEO_GEN always applies it. NONE removes the watermark (requires Pro; returns an error if you don't have it).

numResultsinteger

Number of output results to generate. Defaults to 1.

isOutputTemporaryboolean

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 required

Execution id (e.g. vg_tool_...).

Changes