HeyGenInstall

Summary

Create a HeyGen Video Agent session by sending either a prompt with optional duration, orientation, and avatar constraints, or a custom JSON request body. The request creates a session through HeyGen’s v3 Video Agent endpoint.

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; the prompt and other guided fields are ignored.
• JSON Body (required) — Used in JSON mode. Must be valid JSON representing an object.
• Prompt (required) — Used in guided mode. The trimmed prompt must contain 1–10,000 characters.
• Duration (Seconds) — Used in guided mode. Defaults to 0, which omits duration_sec; a positive value must be at least 5 seconds.
• Orientation — Used in guided mode. A non-empty value is sent as the orientation hint.
• Avatar ID — Used in guided mode. A non-empty value is sent as avatar_id to constrain the agent.

Output shape

One output item per input item, with the HeyGen API response in its json field.

Creates a POST request to /v3/video-agents. If Continue On Fail is enabled, errors are returned as {"error": "..."} in the corresponding output item.

Links

• n8n community nodes installation guide