Skip to main content

Documentation Index

Fetch the complete documentation index at: https://vaquill.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Three widget builds, three trade-offs. Pick the one that matches your team’s stack and feature ceiling.

Embedded Chat Widget

Next.js 15 + TypeScript. Streaming responses, inline citations, US-pinned. Deploy on Vercel with one env var.

Docker Widget

Python FastAPI backend + Vite frontend in one container. Floating or inline embed via script tag.

Widget Pro

Multi-thread sidebar, voice mode (TTS + STT), gamification, cross-tab sync, configurable citation viewers.

Feature comparison

FeatureEmbeddedDockerPro
FrameworkNext.js 15FastAPI + ViteNext.js 15 + React 19
Deploy targetVercelDocker ComposeVercel / Railway
Streaming responsesYes (SSE)NoYes (SSE)
Multi-thread sidebarNoNoYes
Voice mode (TTS + STT)NoNoYes
Cross-tab syncNoNoYes
Inline citation tooltipsYesYesYes
Embed modesiframefloating, inlineiframe, floating
Single-file script embedNoYesYes
JurisdictionUS-pinnedConfigurableConfigurable
PersistenceNoneNoneIndexedDB / localStorage

Pick by use case

If you…Use
Want the leanest US-only chat for a marketing siteEmbedded Chat
Want a single Docker deploy with floating-button embedDocker Widget
Need a Vaquill-style full experience (history sidebar, voice, gamification)Widget Pro

Common embedding patterns

Floating button (Intercom-style)

A single script tag adds a chat bubble to the bottom-right of every page.
<script
  src="https://your-widget-host/embed/script-floating-chatbot.js"
  data-api-url="https://your-widget-host"
></script>

Inline embed

A <div> plus a script tag mounts the chat inline.
<div id="vaquill-widget-embed"></div>
<script
  src="https://your-widget-host/embed/script-inline-embed.js"
  data-api-url="https://your-widget-host"
  data-height="640px"
></script>

iframe

Maximum isolation. Drop into any HTML page or CMS.
<iframe
  src="https://your-widget.vercel.app"
  width="400"
  height="600"
  style="border: none; border-radius: 12px;"
></iframe>

Source

All widgets live at github.com/Vaquill-AI/integrations - widget-next/, widget/, and vaquill-widget-pro/ respectively.