Skip to main content

Widget

The widget lets you embed an agent into another website or product experience.

What you can do

  • Use an embedded chat or speech experience
  • Apply branding coming from the integration
  • Pass runtime text overrides
  • Control light or dark theme
  • Show privacy or terms prompts when required by the integration

Runtime options you may encounter

OptionPurpose
bot_keyIdentifies access to the widget session
welcome_messageOverrides the default welcome text
titleOverrides the widget title
descriptionOverrides the widget description
placeholderTextOverrides the input placeholder
stopGeneratingTextOverrides the stop-generation label
termsText / termsUrlControls terms messaging and link
privacyText / privacyUrlControls privacy messaging and link
disclaimerTextAdds a disclaimer in the widget
`theme=darklight`

Important behavior

  • Widget access depends on a valid integration
  • Some integrations are restricted by allowed domains
  • Some widget setups use a script delivery mode instead of the iframe chat route
  • If terms are refused, chat can remain blocked until the widget is reloaded
warning

The widget is embed-oriented content, not a normal logged-in application page. Access and behavior depend on the integration settings.