Overview

ChatHQ allows you to create, configure, and deploy AI assistants inside a secure workspace. This guide explains how the platform is structured and how the core components work together.

What we offer

• AI Assistants — Create assistants for sales, support, booking, or custom workflows. Configure instructions, knowledge sources, and behavior.
• Embeddable Widget — Add a chat interface to your website with a small snippet. Use your publishable key and restrict embedding to allowed domains.
• REST API — Connect from your backend using your publishable key for server-to-server integration.
• Workspaces — Organize assistants, team members, and settings. Switch context between workspaces.
• Analytics — Track conversations, messages, and engagement.
• Plans & Billing — Upgrade, downgrade, and manage subscriptions via Paystack.

Platform Structure

• Workspace — Your main container. Holds assistants, widget config, publishable keys, members, and branding.
• Assistants — AI instances with instructions, knowledge, and behavior.
• Delivery — Widget (embed) or API.

Each layer builds on the previous one.

Workspace

Your workspace is the main operating environment. It contains:

• All assistants
• Widget configuration and allowed domains
• Publishable keys (for widget and API)
• Rate limits and usage controls (based on your workspace plan)
• Security settings
• Branding preferences
• Team members and roles

Assistants

An assistant is an AI instance configured for a specific role. Each assistant can have its own instructions and knowledge sources.

• Instructions (behavior rules)
• Knowledge sources (documents, URLs, FAQs)

Delivery Options

1. ChatHQ Widget — An embeddable JavaScript snippet. Uses your publishable key and loads only on allowed domains you configure.
2. API — Use your publishable key for server-to-server integration. See Authentication.

Widget: Publishable Key & Domains

After publishing, you get a publishable key (not a secret API key). The widget snippet includes this key. Our backend only allows the widget to load on allowed domains you add in workspace settings.

<script>
window.ChatHQ = window.ChatHQ || {};
window.ChatHQ.workspace = 'YOUR_WORKSPACE_ID';
window.ChatHQ.bot = 'YOUR_BOT_ID';
window.ChatHQ.publishableKey = 'YOUR_PUBLISHABLE_KEY';
window.ChatHQ.position = 'bottom-right';
</script>
<script src="https://cdn.chathq.ai/widget.js" async></script>

API: Server-to-Server

For API access, use your publishable key in server-side code.

Stay updated

Check our blog on the home page for recent updates, new features, and announcements.