FAQSIR
FAQSIR

Answers your users actually find.

An intelligent FAQ widget that understands your users' questions and delivers the right answer, every time.

Get Started
faqsir.js
window.faqsir = window.faqsir || {
  api_key: 'YOUR_API_KEY',
  site_id: 'YOUR_SITE_ID',
};

Introduction

Getting started

Learn how to get FAQSIR set up in your project in under thirty minutes.

Quick Start

Step-by-step guide to installing the widget on your website.

Features

Explore AI summaries, FAQs, chat, video, and sentiment analysis.

Plans & Pricing

Compare plans and find the right tier for your needs.

API Reference

Authenticate and integrate with the FAQSIR API.

Installation Methods

FAQSIR can be installed in two ways:

  • Direct HTML — Add the widget script directly to your page templates. Best when you have access to your site's source code and want full control over where the launcher button appears.
  • Google Tag Manager — Deploy via a GTM Custom HTML tag with no code changes to your site. See the Google Tag Manager guide for the full walkthrough.

This page covers the direct HTML method.

Prerequisites

  • A FAQSIR account with an active subscription (see Plans & Pricing)
  • A FAQSIR API key (accessible from your dashboard)
  • A website where you want to embed the widget

Quick start

Add the following to your HTML page, ideally before the closing </body> tag:

Installing the widget

<script>
  window.faqsir = window.faqsir || {
    api_key: 'YOUR_API_KEY',
    site_id: 'YOUR_SITE_UUID',
  };
</script>

<script type="module" src="https://widget.faqsir.com/index.js"></script>

Don't forget your key

Make sure to replace 'YOUR_API_KEY' and YOUR_SITE_UUID with your actual API key and Site UUID from the FAQSIR dashboard. Without them, the widget won't be able to fetch content from the API. See Authentication for details on how API keys work.

Configuring the Panel

The panel provides a full tabbed modal experience with Summary, FAQs, Video, and Chat tabs:

<faqsir-panel></faqsir-panel>

This renders a launcher button. When clicked, it opens a full-screen modal with all available content tabs. See Components for the full element reference and Configuration for customisation options.

You should know!

Place the <faqsir-panel></faqsir-panel> where you would like the launcher button to appear. The panel will handle the rest, including fetching and displaying content from the API.

What happens next?

Once the widget is installed:

  1. Content generation — When a user visits a page with the widget, the API fetches the page content and generates AI summaries and FAQs. See Sources & Content for details.
  2. Widget display — The generated content is displayed in the widget panel, with tabs for Summary, FAQs, and Chat. Video appears if your plan supports it and credits are available.
  3. Analytics tracking — User interactions with the widget are tracked and available in your Dashboard (Plus plan for Basic Usage Metrics, Pro plan for the full Engagement Dashboard).

Pro tip: Pre-generate content

You don't have to wait for the first visitor to trigger content generation. Call the Source endpoint from your CMS or publishing pipeline to generate summaries, FAQs, and video ahead of time — so everything is ready the moment your article goes live. See Pre-generating content for details.

Explore the documentation

Google Tag Manager

Install the widget via GTM — no code deployment required.

Configuration

Customise the widget's appearance, position, and behaviour.

Chat Widget

Set up the AI chat feature as a panel tab or standalone bubble.

Knowledge Base

Upload documents to enhance AI chat responses (Pro).

Next
Features