Skip to main content
The User Intuition AI widget lets participants start a voice or chat interview without leaving your product. Responses appear on your study dashboard like any other interview. Use it for in-app feedback, post-purchase surveys, churn intercepts, or always-on listening from inside your product.

From the dashboard

On a BYOP study, open the Invites tab and click Invite Participants. Two items give you ready-made code: The generated code sets voice mode, dark theme, bottom-right position, full size, and the consent dialog. Change any of them with the attributes below.
The button is the lighter option: it opens your study link in a new tab. Override its colors, radius, and font with the CSS variables --userintuition-button-background, --userintuition-button-color, --userintuition-button-radius, and --userintuition-button-font.

Quickstart

1

Grab your code

Click Invite Participants → Copy Embed Code on the study dashboard, or call GET /api/public/v1/studies/{study_id}/embed-code?type=widget with your Study ID.
2

Install or include the widget

Run npm install @userintuition-ai/web for React, or drop in the UMD <script> tag for plain HTML.
3

Mount it

Add the generated <userintuition-widget> element and script, or pass its values to <UserIntuitionWidget />.
4

Style and scope

Set theme, position, size, and brand colors. Use show-based-on-url and delay-interval so the widget only appears where it should.
5

Test the interview

Open the page, trigger the widget, and complete a test interview. The response appears on your study dashboard.

Install

The package is published as @userintuition-ai/web.

Embedding methods

There are four ways to mount the widget. Pick the one that matches your stack.

1. HTML custom element

The simplest option. Drop in the script tag and a <userintuition-widget> element anywhere in your HTML.

2. JavaScript loader

If you need to mount programmatically (for example, after a route change or user action), create the same custom element after the widget script loads.

3. React component

For React apps, install the npm package and import the component.

4. Web component variant

For React apps that prefer a thin wrapper around the underlying custom element, use UserIntuitionWidgetWebComponent. It is the package’s default export and the recommended React surface.

Modes

The widget supports three interview modes. Set the mode that fits your audience and the depth of feedback you want.

Position and size

Control where the widget anchors and how much room it takes up on screen.

Position

Size


Theme and branding

The widget ships with light and dark presets. You can override individual colors to match your brand.
You can also customize widget copy with title, cta-title, cta-subtitle, start-button-text, end-button-text, and mode-specific empty-state messages (voice-empty-message, chat-empty-message, chat-placeholder, hybrid-empty-message, and others).
When consent-required is enabled, the widget shows a consent dialog before the interview can start. The participant’s choice is stored in localStorage so they only see the dialog once per device.
Consent state is keyed by consent-storage-key. If you change the key, the widget will treat returning participants as new and prompt them again.

Smart display

You usually don’t want the widget to appear on every page or fire instantly. Use these props to scope when and where it shows.

Voice and reconnect options

Voice mode has a few extra knobs for transcript display and reconnection.

From the API

To fetch the same code programmatically, request its generated HTML with your Study ID:
Copy the returned code into your page. The study must be provisioned. For a simple link instead, use type=button; that response also includes study_link. If you build the widget markup yourself, it needs these values: These values come pre-filled in the code from the Copy Embed Code dialog or the embed-code API. See Study lifecycle in the API reference.
The widget’s public-key is not one of your account API keys, and is safe to ship in client-side code. Never put an account API key from Account settings in a web page.

Browser support

The widget runs in any modern browser that supports:
  • ES6+
  • The Custom Elements API
  • Microphone access (for voice and hybrid modes)
For React installs, React 16.8+ is required as a peer dependency.

Next.js and React Server Components

The widget is a client-only component — it touches window, localStorage, and the microphone. In Next.js 13+ with the App Router, mark the file as a client component.
Don’t import the widget into a server component or render it during SSR. The bundle assumes a browser environment and will throw if it loads on the server.

Next steps

External panels

Route respondents from a panel provider you already use.

Share a study link

The simpler alternative — a hosted URL anyone can open in a browser.