Actions23
- Asset Actions
- Avatar Actions
- List Actions
- Lipsync Actions
- OAuth Actions
- Video Actions
- Video Agent Actions
Avatar → Create Avatar
AI-generatedSummary
Create a HeyGen avatar through the v3 API. Choose a prompt-based avatar and provide its display name and prompt, or enable JSON mode to send a custom object for photo avatars or digital twins.
Inputs
- Authentication — Choose OAuth2 (default) or the legacy API key credential.
- Define Body Using JSON — When enabled, sends the JSON Body object as the request body. Use this for photo avatars or digital twins, supplying the required asset, video, or consent fields for HeyGen.
- JSON Body — A valid JSON object used when JSON mode is enabled; the default template is for a prompt avatar.
- Type — In form mode, select Prompt, Photo Avatar, or Digital Twin. Photo Avatar and Digital Twin require JSON mode; selecting either in form mode produces an error.
- Name — Required in form mode: the new avatar's display name.
- Prompt — Required when form mode uses the Prompt type: text describing the avatar.
Output shape
A single item containing the HeyGen API response for each input item.
Sends a POST request to the v3 avatars endpoint. In JSON mode, the body must parse as a JSON object; in form mode, Name is required, and Prompt is also required for the Prompt type. Errors are returned as an error item when the node is set to continue on fail; otherwise execution fails.