AuraAura Docs

Setting Up the Widget

Enable the widget, set its position, and add it to your site.

The widget lives on the Widget tab of your companion's profile editor. Everything you need to go live is on that one screen.

Enable the widget

Open your companion's profile, go to the Widget tab, and turn on Enable Widget. This is what the runtime checks before it will render anything on your site — leave it off and the widget stays invisible even if the script tag is installed.

Choose a placement

Pick Bottom-right or Bottom-left from the Placement dropdown. This is the only visual option you control — it decides which corner of the screen the launcher sits in.

Restrict allowed domains (optional)

Under Allowed Domains, type a domain and press Enter, comma, space, or Tab to add it as a chip. Leave the list empty to allow the widget to run on any origin — add domains here to restrict it to just your own site(s).

Only the hostname matters; a leading www. is stripped automatically when you add a domain.

Copy the embed snippet

Under Embed Code, copy the script tag. It looks like this:

<script src="{host}/widget/aura-widget.v1.js" data-aura-assistant="{assistantId}" async></script>

Paste it into your site's HTML just before the closing </body> tag. The data-aura-assistant attribute is what ties the script to your specific companion — each companion gets its own snippet.

Save your changes

Save the profile like you would any other tab. Changes to enable/disable, placement, and allowed domains take effect on your live site within about a minute — the runtime config is cached for 60 seconds.

How it loads

The script tag is static and identical for every companion — it doesn't carry any per-companion data itself. When it runs on a visitor's page, it fetches your companion's live configuration (enabled state, position, allowed domains, name, avatar, and available modes) from Aura, then builds the launcher and chat panel from that. If your companion is disabled, or the visiting page's domain isn't on your allowed list, the widget simply doesn't render — there's no broken UI left behind.

Appearance — colors, launcher style, and greeting text — is fixed to Aura's brand defaults and isn't something you set here. And whether visitors see a voice option, a text option, or both is decided by your companion's output modes on the Behaviour tab, not by anything on this Widget tab.

Last updated on

On this page