Chirps Documentation

Chirps is a RAG-powered customer support platform. Your assistant reads your real content before answering—no manual flowcharts. Visitors chat on your site; you manage everything from the dashboard at chirps.cc.

What Chirps does

• Answers from your knowledge — website crawl, PDF uploads, text snippets.
• Embeds in minutes — one script tag via embed.js.
• Captures leads — in-chat forms and booking calendars.
• Alerts your team — WhatsApp, SMS, Telegram, Discord, email dispatch.
• Voice support — browser voice calls and optional dedicated phone numbers.
• Human takeover — agents reply live from the inbox when needed.

Who it is for

• E-commerce — shipping, returns, product questions (see Shopify guide).
• SaaS — onboarding and docs deflection.
• Local services — after-hours intake and callbacks.
• Agencies — one assistant per client site.

How it differs from legacy chatbots

Documentation map

This guide covers the full platform. Start with Getting Started, then Knowledge Base, Widget, and Troubleshooting. Public help: Support and Blog.

Chirps turns your website and documents into a 24/7 AI support agent. You do not build decision trees—you point the assistant at your content, customize the widget, and paste one script on your site.

1. Create your account

Go to Sign up and register with email/password or Google OAuth. After confirmation (email signups), sign in at Login. You land on your dashboard—your workspace home.

2. Start the 7-step wizard

Click New Assistant in the sidebar or dashboard header. You are taken to the create wizard. Progress auto-saves to your browser as a draft.

Step 1 — About You

• Business name (2–100 characters)—shown in the widget header.
• Website URL—used as the default crawl source and domain lock for the embed.

Step 2 — Learning

Choose how the assistant learns:

• Website URL — crawl public pages from your domain.
• Document — upload PDFs, DOCX, TXT, MD, or images.
• Both — crawl plus files.
• None — skip for now; add knowledge later in the Knowledge tab.

Step 3 — Language

• Primary language — default reply language.
• Multi-language — assistant recognizes and replies in visitor language when enabled.

Step 4 — Personality

Pick a tone preset: Professional, Friendly, Concise, Empathetic, Enthusiastic, or Custom with your own description (max 2,000 characters).

Step 5 — Human Backup

• Support email — where human escalations can route.
• Max pages — how many URLs to crawl (slider 1–50, capped by your plan).
• Max depth — how many link levels deep to follow (1–20, plan-capped).

Step 6 — Guidelines

Optional additional instructions (up to 10,000 characters). Examples: refund policy boundaries, competitor mentions, tone rules.

Step 7 — Review & Launch

Review your choices and click Launch Assistant. A setup overlay runs while Chirps crawls, indexes, and generates your system prompt.

3. Setup pipeline states

1. Planting the seeds… — assistant record created.
2. Learning your business… — crawler fetches pages and documents.
3. Syncing the knowledge… — embeddings and prompt generation.
4. Your assistant is ready! — you can open the assistant dashboard.

Typical duration: 15–30 seconds. On failure you can retry or skip to the dashboard and fix knowledge manually.

4. Copy your embed code

Open your assistant → Integration tab (`?tab=integration`). Copy the snippet:

<script>
  window.chirpsConfig = { assistantId: "YOUR_ASSISTANT_ID" };
</script>
<script src="https://chirps.cc/embed.js" async></script>

Paste before `</body>` on your site (or use platform guides under Integration). See Integrations for WordPress, Shopify, Webflow, and more.

5. Post-launch checklist

1. Appearance — brand colors, welcome message, starter suggestions, dark mode if needed.
2. Knowledge — verify crawled pages; add missing URLs or PDFs; click Train AI Engine.
3. Notifications — connect WhatsApp, SMS, Telegram, or email for lead alerts.
4. Settings — set authorized domain; turn off Developer Mode before production.
5. Ask 5 real customer questions on your live site and fix any gaps in knowledge.

After login at chirps.cc you see a persistent sidebar, workspace switcher, and notification bell. What you can access depends on your role—owners and admins see everything; collaborators see only permitted sections.

Sidebar navigation

Workspace home

Route: /dashboard

Stats cards

• Total Assistants — deployed agents in this workspace.
• Total Sessions — unique visitor conversation threads.
• AI Satisfaction Rate — CSAT from thumbs up/down surveys.
• Message Exchanges — lifetime message count.
• Assistant Messages (Billed) — AI replies this month toward your plan cap.

Deployed Agents list

Each card shows business name, favicon, status (Online, Paused, or setup states), and links to your assistant detail page.

Workspace switcher

Switch between your personal workspace and team workspaces you belong to. Your personal workspace shows a Default badge. Billing limits always apply to the workspace owner, not the logged-in member.

Notifications bell

Team invites and alerts appear here. Accept workspace invites from the bell—there is no separate invite landing page.

Assistant command center

Each assistant opens at `/dashboard/assistants/[id]` with these tabs (`?tab=` query):

• overview — metrics and performance chart
• conversations — inbox for this assistant
• appearance — widget customizer
• artifacts — forms, booking, cards, CSAT
• notifications — dispatch channels
• integration — embed code and platform guides
• knowledge — crawl, train, harvest
• phone — voice number and dispatch add-ons
• settings — status, domain lock, rate limits, GDPR, delete

Until setup is ready, you only see the setup progress screen—not the tabs. See Assistant Tabs for every field.

Open any assistant from your dashboard. Use the tab bar to configure behavior. Click Publish Changes on Appearance after edits.

Overview tab

Route: `?tab=overview`

• KPI cards: sessions, CSAT, billed AI messages, combined AI+agent messages, total messages.
• Performance Trends chart with 7 / 14 / 30 / 90 day filter.
• Monthly Cap progress bar for billed AI interactions.
• Response breakdown: AI Managed, Human Assisted, User Interactions.
• Engine Configuration summary: personality, language, knowledge source.

Appearance tab

Route: `?tab=appearance` — live widget preview on the right.

Text & content

Theme & layout

• Widget Theme — Light or Dark.
• Bubble Style — circle, bar, drawer (standard or branded with logo).
• Primary Color — color picker + hex.
• Position — bottom-right, bottom-left, top-right, top-left.
• Page Visibility — all pages, only these paths, or all except (supports `/*` wildcards).

Feature toggles

Voice settings

When voice is enabled: pick AI Voice Model and Physical Voice (30+ options with preview).

Artifacts tab

Route: `?tab=artifacts` — full guide: Artifacts & Forms

• Lead / Contact Forms — custom fields, multi-step wizards.
• Booking & Scheduling — Google Calendar OAuth, services, time slots.
• Product / Service Cards — CTA links inside chat.
• CSAT Survey — thumbs up/down with trigger rules.
• Custom artifacts — JSON schema (Starter+ / Pro tier 5+).

Notifications tab

Route: `?tab=notifications` — see Notifications & Phone

Channels: WhatsApp, SMS, Telegram, Discord, Email, Webhook (Enterprise). Template variables and Test button per channel.

Integration tab

Route: `?tab=integration`

Copy embed snippet and follow platform steps. All guides: Integrations.

Knowledge tab

Route: `?tab=knowledge` — Knowledge Base chapter.

Communication tab

Route: `?tab=phone` — buy numbers at Communications.

Settings tab

Route: `?tab=settings`

General

Assistant Status toggle — Live or Inactive.

Security & access

• Authorized Domain — widget only loads on matching host (subdomains allowed).
• Developer Mode — bypass domain lock for localhost/staging.

Rate limiting

Per-visitor cap: default 30 messages per 60 minutes. Adjustable 5–500 messages, 1–1440 minute window.

Privacy & GDPR

• Require Consent to Chat — consent screen before chat opens.
• PII Data Masking — server-side redaction of emails, phones, cards.

Danger zone

Delete assistant — type exact business name to confirm.

Chirps uses RAG (Retrieval-Augmented Generation): every answer starts with a search of your indexed content. If the fact is not in your knowledge base, the assistant should escalate—not guess.

Open the Knowledge tab

In your assistant dashboard: Knowledge (`?tab=knowledge`). The left sidebar shows your Knowledge Blueprint—blocks, insights, and sync status.

Add a knowledge block

Click Add → Add Knowledge Block:

Add, Recrawl & Train (URLs) or Add & Train (snippets/files) saves and indexes the content.

Crawl limits

• Max pages — set at creation (1–50); capped by your plan.
• Max depth — how many link levels to follow (1–20).
• Initial wizard crawl does not consume recrawl/train credits.
• Manual Re-crawl per URL node consumes monthly recrawl quota.

Engine actions

Train AI Engine

Rebuilds embeddings from all active blocks. Consumes train quota. Run after editing content or adding blocks.

Re-crawl & Train

Re-fetches all URL nodes, then trains. Use after a site-wide pricing or policy update.

Harvest Insights from Chats

Scans conversations for knowledge gaps. Up to 3 insights per run. Review in sidebar → Graduate good insights to permanent facts.

Editor sub-tabs

• Refinery — edit cleaned text (`refined_content`), toggle active, per-node re-crawl.
• Identity — business name, description, language, tone, support email, guidelines.
• AI Head — raw system prompt (advanced).
• Visualization — Mermaid knowledge graph.

Fix wrong or "I don't know" answers

1. Check if the page was crawled (Knowledge sidebar list).
2. Run Re-crawl on that URL or upload a PDF with the missing info.
3. Click Train AI Engine.
4. Test the same question in the live widget.
5. If still stuck, add a short FAQ paragraph on your public site and recrawl.

Hit a quota limit? Upgrade at Billing or wait for the UTC month reset.

Visitors see a chat bubble on your site. When they open it, they get a branded panel powered by embed.js—isolated in Shadow DOM so your site CSS does not break the widget.

Launcher (bubble) styles

Configure in Appearance (`?tab=appearance`). Position: bottom-right, bottom-left, top-right, or top-left.

Chat features

• Messages — markdown-lite formatting, link previews, source citation pills.
• Starter suggestions — up to 3 welcome pills; tap to auto-send.
• Inline suggestions — AI-generated quick-reply pills under replies.
• Reply to message — quote an assistant reply and follow up.
• Thinking bubble — shimmer text while AI processes; updates with status labels.
• Unread badge — count on bubble when chat closed; optional preview toast + sound.

Input bar

• Text — up to 2,000 characters; Enter to send.
• Voice call — waveform button when input empty (if voice enabled).
• Dictation — mic for speech-to-text (browser Speech Recognition).
• Attach (+) — file picker or screenshot capture (Pro file upload).

File attachments (Pro)

PDF, TXT, MD, DOCX, PNG, JPG, WEBP — max 5MB. Images preview in the user bubble.

Voice calling

Visitor-initiated

Tap voice button → full-screen overlay: timer, visualizer, mute, minimize, end call. AI greets on connect. Artifacts (forms/booking) can appear during calls.

AI-initiated

Incoming call overlay with ringtone — visitor Accept or Decline.

GDPR consent

When enabled in assistant Settings, visitors see a Privacy Notice screen with I Agree & Continue before chat opens. Pair with a Privacy Policy URL in Appearance. See Privacy Policy for your own site policy.

Dark mode

Set Widget Theme to Dark in Appearance. Thinking bubble, attach menu, GDPR screen, and message area follow the dark palette.

Human agent (visitor view)

When an agent takes over from the dashboard inbox, the header shows the agent name and avatar. There is no "Talk to human" button—escalation is triggered by the AI or your team.

Mobile

• ≤480px: chat fills the viewport.
• Expanded mode on tablet: near-fullscreen panel.
• Drawer mode: full-width bottom sheet on small screens.

Artifacts are interactive UI blocks the AI shows during conversation—forms visitors fill out, calendars they book from, or cards they click. Configure them in Artifacts (`?tab=artifacts`).

Lead / Contact forms

• Default fields: Full Name, Email, Phone, Details.
• Add custom fields: text, email, tel, textarea, select, radio, checkbox, slider, date, url, location (map picker).
• Multi-step wizard when more than one field.
• Submit → saved to Leads + dispatch notifications.

Trigger rules

Define when the AI should show the form (e.g. "when user asks for a quote" or "after pricing question").

Booking & scheduling

1. Connect Google Calendar from the Artifacts tab (OAuth returns via calendar callback).
2. Add services with duration, category, and routing (virtual / physical / phone).
3. Set working hours, buffer time, blocked dates, and timezone.
4. Visitor picks service → date → time slot (live from calendar API) → intake form → confirm.

Success shows confirmation text and fires booking_confirmed dispatch to your notification channels.

Product / service cards

Single or carousel cards with title, description, gradient banner, and CTA link. Use for product recommendations or case study highlights.

CSAT survey

Thumbs up / down after support interactions. Feeds satisfaction metrics on the assistant Overview tab and Analytics.

Custom artifacts

JSON schema editor for bespoke components. Requires Starter+ or Pro tier 5+ (`custom_artifacts`). Widget shows a placeholder and fires a `chirps:artifact` event for custom host-page rendering.

Configure notification channels per assistant in Notifications (`?tab=notifications`). Buy phone numbers workspace-wide at Communications.

Dispatch events

• Lead Captured — contact form or legacy lead submitted.
• Booking Confirmed — calendar booking completed.
• Agent handoff — human takeover (when configured).

Channel reference

Template variables

Use in HTML/text templates: `{{form_data}}`, `{{form_data_html}}`, `{{timestamp}}`, `{{lead_location}}`, `{{dashboard_url}}`, `{{booking_routing}}`, `{{notes}}`.

Click Test on any channel to send a sample without waiting for a live event.

Buy a phone number

1. Open Communications or assistant Phone tab.
2. Choose country (US, CA, GB, AU, IE, SE, FI, EE, LT, PL) and optional area code.
3. Select a number from the search results.
4. Set voice minutes slider (60–5,000) and optional SMS/WhatsApp bundles.
5. Assign to an assistant → Subscribe & Claim via Stripe Checkout.

Voice usage

• Inbound calls answered by AI using the same knowledge as chat.
• Transcripts saved in Conversations.
• Minutes tracked against included bundle; overage billed per minute.
• AI Call Back from inbox can place outbound calls to visitors.

Standalone dispatch add-on

SMS/WhatsApp monthly bundles without buying a voice number—same checkout flow under Standalone Dispatch tab.

Manage subscriptions at Billing → Manage Billing.

The Conversations inbox is your live support queue. Leads stores form submissions. Analytics shows workspace-wide trends.

Conversations inbox

Filters

• Search by session ID.
• Status: All, Live (agent active), Online (<2 min activity), Offline.
• Type: Booking, Form.
• Assistant dropdown — workspace-wide or per-assistant tab.
• Artifact: Booking, Lead, Call.

20 conversations per page. Realtime updates when new threads start.

Conversation detail

• Full message thread (user, AI, agent roles).
• Agent Active toggle — reply as human; visitor sees your name/avatar.
• Download Transcript (.txt).
• AI Call Back — enter reason → outbound voice call.
• Linked artifacts and lead data.

Leads

Route: /dashboard/leads

• Filter: New, Contacted, Archived.
• Filter by assistant.
• Open detail sheet → update status → view linked conversation.
• Export CSV for CRM import.

Analytics

Route: /dashboard/analytics

• KPI cards, charts, hourly heatmap.
• Top assistants by session volume.
• Country breakdown and agent involvement stats.
• Date ranges: 7D, 14D, 30D, 90D.

Per-assistant metrics also appear on the assistant Overview tab (`?tab=overview`).

CSAT feedback

Thumbs up/down from CSAT artifacts feed into Satisfaction % on Overview and Analytics.

Plans and usage live at Billing. Team management at Workspace Teams. Limits always bill to the workspace owner.

Plan tiers (pricing page)

*Enforced limits come from the database plan row. See full comparison at Pricing.

Usage meters

• Assistant Messages — billed AI replies per month.
• Knowledge Quota — harvest + recrawl + train combined.
• Dispatching Quota — SMS + WhatsApp + email sends.
• Assistants Created — concurrent ready assistants.
• Collaborator Seats — invited non-owner members.
• Workspace Joins — external workspaces you can join.

Feature gates

Invite team members

Administrators: Workspace Teams → enter email → set Permissions → Send Invite.

Permission categories

• Workspace: view conversations, leads, billing, create/manage assistants, phones, notifications.
• Assistant access: all assistants or specific ones.
• Tabs: knowledge, settings, analytics, embed, customize, conversations per member.

Invitee accepts via the notification bell on their dashboard.

Payment issues

Downgrade / cancel

Canceling or downgrading runs scrubToPlanLimits: branding re-enabled, file upload/voice may disable, excess assistants deactivated.

Questions? Open a billing ticket or email team@monzed.com via Support.

Every platform uses the same embed code. Step-by-step guides for each builder live on chirps.cc under Integrations.

<script>
  window.chirpsConfig = { assistantId: "YOUR_ASSISTANT_ID" };
</script>
<script src="https://chirps.cc/embed.js" async></script>

Replace `YOUR_ASSISTANT_ID` with the ID from your assistant Integration tab (`?tab=integration`).

Platform guides

No-code & dev tool pages

• Bolt.new
• Lovable
• v0
• Cursor
• VS Code
• Windsurf
• Claude Code
• GitHub Copilot
• Xcode
• Antigravity
• Emergent
• Base44

Domain lock & staging

• Widget loads only on domains matching your authorized domain (Settings tab).
• Enable Developer Mode for localhost and preview URLs.
• Disable Developer Mode before production launch.

Test before launch

1. Publish your site with the embed snippet.
2. Open the live URL in an incognito window.
3. Ask: pricing, shipping/returns, contact, and one product-specific question.
4. Submit a test lead form and confirm dispatch alert arrives.
5. Turn off Developer Mode if it was on.

New to Chirps? Start at Getting Started or Sign up.

The widget is a browser client that talks to chirps.cc APIs. You do not need API keys to embed—only your public `assistantId`.

Load sequence

1. Site loads `https://chirps.cc/embed.js` with `window.chirpsConfig.assistantId`.
2. embed.js fetches `GET /api/assistants/{id}/widget-config`.
3. Domain lock check (403 if origin ≠ authorized domain, unless Developer Mode).
4. Loads `widget.js` and mounts Shadow DOM chat UI.

Visitor-facing endpoints

Security

• Domain lock — `business_url` host must match page origin; subdomains allowed.
• Developer Mode — bypasses lock for staging (disable in production).
• Rate limiting — per-visitor message cap (Settings tab, default 30/hour).
• PII masking — optional server-side redaction when enabled.

Dashboard-only APIs

Authenticated session routes (not for embed): assistant CRUD, train, harvest, widget-config PATCH, billing, team invite, notification channels. Managed only from dashboard after login.

Webhooks (server-to-server)

• Stripe → `POST /api/billing/webhook`
• Twilio → `POST /api/twilio/*` for voice and SMS
• Your server ← Enterprise Webhook dispatch channel on lead/booking events

Full product docs: Documentation · Privacy · Terms.

Most issues fall into four buckets: embed/domain, knowledge gaps, plan limits, or dispatch config. Still stuck? Contact support or email via Support page.

Widget & embed

Answers & knowledge

Billing & limits

Dispatch & phone

Team & access

Booking & calendar