HeyGen

What it does

Uptale can already generate avatar videos with its default AI model (Microsoft speech studio). Once the HeyGen integration is active, HeyGen is added as a second choice in the AI model list, with HeyGen's avatars and voices, including the ones your organisation created in HeyGen.

• The text the creator writes, and the chosen avatar and voice, are sent to HeyGen with your API key. HeyGen creates the video and Uptale adds it to the experience's media.
• HeyGen is a separate service: HeyGen's own terms apply, and generation uses your HeyGen account and its credits. See Data & privacy.
• Learners only see the finished video, like any other video in the experience: they don't need HeyGen.

Requirements

• An active HeyGen account for your organisation, with enough credits to generate videos.
• An API key created in that HeyGen account (see HeyGen's own documentation).
• An Environment Administrator of your Uptale environment, to enter the key. No action from Uptale is needed.

Set up the HeyGen integration

Your Environment Administrator sets up the integration once for the whole environment.

1. Open the Administration menu, click the Integration tab, then Open details on the HeyGen card (category Creation and AI tool).
2. Click Configure this integration, then Edit.
3. Enter your HeyGen API Key and click Save and activate. To save the key without activating the integration yet, click Save instead.

The State changes to Activated. From then on, HeyGen is offered to everyone who can edit experiences in your environment: Environment Administrators, Workspace Administrators and Creators.

Once saved, the key is masked: it isn't displayed again.

Change the key or turn it off

• Replace the key: open the integration, click Edit, enter the new key and click Save.
• Turn it off: switch off Configuration activation. The key is kept, and you can switch it back on at any time.
• Remove it: click Delete configuration. The saved key is removed; to use HeyGen again, set it up from the start.

See How integrations work for the states of an integration.

Generate an avatar video with HeyGen

1. Open the experience in the Studio, then open the media manager and select 2D Video.
2. Click Generate an avatar video.
3. Under Video parameters, enter a Video name.
4. In AI model, select HeyGen.
5. Choose the Language, then the Accent, the Voice and, if offered, the Emotion.
6. Type the text the avatar will say in the Speech (advanced features) field. A counter shows how many characters you have left.
7. Choose an avatar in the list; use the search field to find one by name.
8. Click Generate.

The video is added to the 2D Video media of the experience once HeyGen has created it. Use it in your scenes like any other 2D video.

To change the text, the voice or the avatar later, open the menu of the video in the media manager and choose Edit AI generation parameters. Then click Save to replace the video, or Save as new media to keep both.

Your own HeyGen voices and avatars

• Custom voices created in your HeyGen account appear automatically in the voice list, with no extra step in Uptale.
• Custom avatars appear at the top of the avatar list. Only avatars created from a video are supported: avatars created from a single photo don't appear.

Limits

• With HeyGen, you can't listen to the voice before generating: the Listen preview is only available with Microsoft speech studio.
• Only HeyGen avatars created from a video are supported.
• Each video uses your HeyGen credits. When your HeyGen account has no credits left, HeyGen refuses the request and the integration shows In error.