Skip to main content
The assistant answers questions on your Mintlify site. To embed the same capability on another site or web app, use the widget. With the widget, you can give your users access to AI chat trained on your content in your product dashboard, marketing site, support portal, or elsewhere. Use the @mintlify/assistant-widget package to add your Mintlify assistant to any website or web application. The hosted package owns its trigger and renders inside a closed Shadow DOM, which prevents your application styles from affecting the widget. The only required browser option is the public widget ID. Manage the enabled state, allowed origins, attachments, and bot protection in your dashboard. Set embed-specific starter questions and a support email in the browser configuration.

​
Prerequisites

​
Enable the widget

  1. Navigate to your deployment’s Widget page.
  2. Enable the widget.
  3. Add allowed origins where you embed the widget.
  4. Copy the widget ID.

​
Install and configure

Use the playground to configure the presentation, visual options, and observer hooks for your widget. The installation code block updates as you change each option.
Replace YOUR_WIDGET_ID in the generated code with the widget ID from the Widget page of your dashboard.
After you add the generated code to your site, reload the page. Confirm the trigger appears, then click it and send a test question to verify the widget is connected.