Skip to main content

How do I deploy an Interactive Avatar?

Learn how to deploy an Interactive Avatar in Synthesia as a widget, an embed, or a hosted link.

Written by Meg Farley

You deploy an Interactive Avatar to decide where visitors can talk to the Avatar. You can deploy an Interactive Avatar as a widget, an embed, or a hosted link.

✍️ Interactive Avatars is in beta. Features and options can change.

Choose a Deployment Type

Synthesia offers three deployment types for an Interactive Avatar:

  • Widget: Adds the Avatar to your own website pages.

  • Embed: Places the Avatar inline on a page of your website.

  • Hosted link: Opens the Avatar on a page that Synthesia hosts. The page works on any device and needs no code.

To start, open your Interactive Avatar, select the Deploy tab, and select Set up for the type you want.

After you create a deployment, the Deploy tab lists your deployments with their name, type, creation date, and status, such as Not live or Live. To add another one, select Add.


Add the Widget to Your Website

To add the widget to your website:

  1. Open your Interactive Avatar, and select the Deploy tab.

  2. Select Set up for the widget.

  3. Select Create.

  4. Follow the steps in the Go live checklist to set the widget live:

    • Publish your Interactive Avatar: This item is complete when your Avatar is published.

    • Add a website: Under Embed security, type the address of each website that can embed the widget, and then press Enter.

    • Go live: Select Go live after the other items are complete. The status changes to Live.

  5. Under Embed code, select Copy.

  6. Paste the snippet into each page where the widget should appear.

✍️ Under Embed security, type https://example.com to allow one website, or type https://*.example.com to allow a site’s subdomains.

Customize the Widget

The widget has settings for where it appears, how it looks, and how it behaves. To change these settings, open the widget on the Deploy tab:

  • Bot protection: Keeps automated traffic from using up your credits. When Bot protection is on, the widget checks that visitors are human before a conversation starts. Most visitors see nothing. Bot protection is powered by Cloudflare.

  • AI disclosure: A setting you turn on. When it is on, an AI label appears and visitors are told they are talking to an AI.

  • Expanded behavior: Choose how the widget first shows up for visitors, such as Starts expanded.

  • Position: Choose where the widget sits on your page: Top left, Top right, Bottom left, or Bottom right.

  • Logo: Show your logo on the launcher instead of the Avatar’s face. Upload a PNG, JPG, or WEBP file up to 1 MB.

  • Styling: Match the call buttons to your brand by setting the Accent and Accent primary colors.


Add an Embed to Your Website

An embed places the Avatar inline on a page of your website. To add an embed:

  1. Open your Interactive Avatar, and select the Deploy tab.

  2. Select Set up for the embed.

  3. Follow the steps in the Go live checklist to set the embed live:

    • Publish your Interactive Avatar: This item is complete when your Avatar is published.

    • Add a website: Under Embed security, type the address of each website that can embed the Avatar, and then press Enter.

    • Go live: Select Go live. The status changes to Live, and your snippet appears.

  4. Under Embed code, select Copy, and then paste the snippet where the Avatar should appear on the page.

Until you go live, the embed shows Not live, and the snippet area stays empty.

Customize the Embed

The embed has these settings:

  • Bot protection: Checks that visitors are human before a conversation starts. Most visitors see nothing. Bot protection is powered by Cloudflare.

  • AI disclosure: A setting you turn on. When it is on, an AI label appears and visitors are told they are talking to an AI.

  • Styling: Matches the call buttons to your brand. Accent sets the color of the call buttons, and Accent primary sets the text and icon color on the call buttons.


Share a Hosted Link

A hosted link opens your Interactive Avatar on a page that Synthesia hosts. To set up and share a hosted link:

  1. On the Deploy tab, open the hosted link.

  2. Follow the steps in the Go live checklist to set the link live:

    • Publish your Interactive Avatar: This item is complete when your Avatar is published.

    • Go live: Select Go live. Your link appears.

  3. Select Copy to copy the link, or select Open in new tab to try the link.

  4. Share the link. Anyone with the link can start a conversation.

The hosted page also has a Bot protection setting. It checks that visitors are human before a conversation starts. Changes take up to 5 minutes to reach visitors.


Turn Off or Delete a Deployment

You can turn off a deployment without deleting it, copy its code or link, or delete it.

To pause a deployment without deleting it, turn off the toggle next to its Live status.

To copy a deployment’s code or link, or to delete the deployment, open the ... menu. The menu has Copy code for a widget or an embed, Copy link for a hosted link, and Delete for all three.

When you delete a widget, pages with the snippet stop showing the widget within a few minutes. When you delete a hosted link, the link stops working for everyone who has the link. The Avatar and its conversation history stay.

✍️ You cannot undo the deletion of a deployment.


💬 FAQs

What is the difference between a widget, an embed, and a hosted link?

A widget adds the Avatar to your own website pages after you paste a snippet into the pages. An embed places the Avatar inline on a page of your website after you go live and paste a snippet. A hosted link opens your Interactive Avatar on a page that Synthesia hosts, works on any device, and needs no code.

How do I add another deployment to an Interactive Avatar?

Open the Interactive Avatar, select the Deploy tab, and then select Add. The Deploy tab lists your existing deployments.

How do I set a deployment live?

Follow the steps in the Go live checklist on the deployment. For a widget or an embed, publish your Interactive Avatar, add a website, and then select Go live. For a hosted link, publish your Interactive Avatar and then select Go live. The status changes from Not live to Live.

Can I pause a deployment without deleting it?

Yes. Turn off the toggle next to the Live status on the deployment. The deployment stays in your list.

How do I delete a deployment?

Open the deployment, select the ... menu, and then select Delete. You cannot undo the deletion.

Which websites can embed my Avatar?

Only the websites you add under Embed security can embed your Avatar. Type https://example.com to allow one website, or type https://*.example.com to allow a site’s subdomains.


What's Next?

📚 To create an Avatar to deploy, check out How do I create an Interactive Avatar?

📚 To review conversations from your deployments, check out How do I manage my Interactive Avatars?

Did this answer your question?