Generate avatar
generate_avatarCreate a talking-head avatar video from an actor and uploaded audio. Provide actorEntityId and audioFileId; set avatarQuality if needed, and expect a few minutes.
Instructions
Generate a talking-head avatar video from an ACTOR entity and an uploaded audio file. Pass actorEntityId and optionally set avatarQuality. Typically takes a few minutes (longer for longer audio). Tell the user that wait up front.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| audioFileId | Yes | Audio file id for the avatar to lip-sync. | |
| actorEntityId | Yes | Id of a built-in stock actor or an ACTOR entity (vg_enti_...) with an image reference. | |
| avatarQuality | No | Avatar generation quality tier. Applies when actorEntityId is provided. Omit to use workspace settings. |
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). |