Documentation

Complete guide to using Code Huddle AI Knowledge Base platform.

Getting Started

Learn how to set up your AI knowledge base and start chatting with your documents.

1. Creating Your Account

New accounts are provisioned by our team. Use "Get Started" on the site to email hr@code-huddle.com, or sign in if you already have credentials.

2. Uploading Your First Document

Navigate to the Knowledge Base section in your dashboard. Upload documents in various formats (PDF, DOCX, TXT, MD, etc.). Our system will automatically process and index your documents in real-time.

3. Configuring Your Chatbot

Go to Chatbot Settings to customize your AI assistant. Set your company name, choose personality tones, configure response settings, and customize system prompts to match your brand.

4. Starting Your First Conversation

Once your documents are processed, start chatting with your knowledge base. Ask questions about your uploaded content and get instant, context-aware responses powered by advanced AI.

Features

Explore all the powerful features available in Code Huddle.

upload_file

Document Management

Upload and manage your documents, files, and knowledge base. Support for multiple file formats with automatic indexing and processing.

forum

Conversation Management

Track and manage all conversations. View chat history, monitor usage, and analyze interactions with detailed logs.

chat

AI-Powered Chat

Chat with your knowledge base using advanced AI. Get instant answers from your documents with context-aware responses.

database

Knowledge Base

Build a comprehensive knowledge base from your documents. Automatic indexing and intelligent search capabilities.

settings

Customizable Settings

Customize your chatbot with personalized branding, personality tones, response settings, and system prompts to match your needs.

sync

Real-time Processing

Real-time document processing and indexing. Get instant updates as your knowledge base grows and evolves.

extension

Widget Integration

Embed your chatbot on any website with our easy-to-use widget. Works seamlessly across all platforms and frameworks.

code

Developer Friendly

Built for developers with comprehensive documentation, API references, and code examples for quick integration.

key

API Access

Integrate with your applications using our RESTful API. Secure API key authentication for seamless integration.

Widget Integration

Embed your chatbot on any website using our embeddable widget. The widget is framework-agnostic and works on any website.

Quick Integration

Add the widget to your website with just two script tags:

<script src="https://huddle-chatbot-frontend.vercel.app/widget.js"></script>
<script>
  CodeHuddleWidget.init({
    accessToken: 'YOUR_API_KEY'
  });
</script>

API Key Setup

Generate an API key from your dashboard's API Keys section. The widget uses this key to authenticate and automatically fetch your chatbot settings.

Learn More

For detailed integration instructions, see the Guides section.

Widget Integration Methods

Code Huddle provides two integration approaches: use our ready-made widget for quick deployment, or build a custom widget for complete design control. Both methods leverage the same powerful API.

Method 1: Default Widget Integration

The fastest integration method. Embed Code Huddle's pre-built widget with minimal code. Ideal for most websites requiring a professional chat interface without custom development.

Implementation

<script src="https://huddle-chatbot-frontend.vercel.app/widget.js"></script>
<script>
  CodeHuddleWidget.init({
    accessToken: 'YOUR_API_KEY',
    position: 'bottom-right',
    primaryColor: '#3b82f6'
  });
</script>

Benefits:

Quick setup in minutes
Automatic settings synchronization
Built-in error handling and loading states
Mobile responsive by default
Works with any framework or plain HTML

For detailed configuration options, see the Guides section.

Method 2: Custom Widget Development

Build a fully custom widget design while using Code Huddle's API for AI processing. Perfect for brands requiring complete design control, custom features, or framework-specific implementations.

Required API Endpoints

GET /api/v1/settings

Retrieve chatbot configuration (name, welcome message, avatar). Authenticate using X-API-Key header.

POST /api/v1/chat/stream

Send messages and receive streaming AI responses using Server-Sent Events (SSE). Include conversation_id for conversation continuity.

Use Cases:

Brand-specific design requirements
Framework-specific components (React, Vue, Angular)
Mobile app integration (React Native, Flutter)
Custom features beyond default widget
Unique layout or positioning needs

📖 Full Documentation: Complete implementation guides, code examples (JavaScript, React, Vue), and API specifications are available in the CUSTOM_WIDGET_DESIGN.md file or API Reference section.

API Key Management

Both integration methods require an API key for authentication. Generate keys from your dashboard's API Keys section.

Security Note: Keep API keys secure. Never expose them in publicly accessible client-side code. Use environment variables or server-side proxies in production environments.

Conversation Management

Track, monitor, and analyze all conversations with your AI knowledge base.

Viewing Chat History

Access the Conversations section in your dashboard to view all past interactions. Each conversation includes timestamps, user queries, and AI responses.

Usage Analytics

Monitor your usage statistics including total conversations, messages processed, and API calls. Track your usage patterns to optimize your knowledge base.

Export Conversations

Export conversation logs in CSV format for analysis, reporting, or compliance purposes.

Best Practices

Tips and best practices for getting the most out of Code Huddle.

Document Organization

Organize your documents logically. Use clear file names and structure your knowledge base for easy navigation and better AI understanding.

Optimizing Responses

Customize your chatbot's personality and system prompts to match your brand voice. Test different configurations to find what works best for your use case.

Security

Keep your API keys secure. Never commit them to version control. Use environment variables and rotate keys regularly for enhanced security.

Testing & Deployment

Test widget integration thoroughly in a development environment before deploying to production. Monitor conversation logs to ensure optimal performance.