📚 Jiminy Documentation

Complete guide to creating intelligent AI chatbots. Learn how to build, train, and deploy smart assistants for your website.

Quick Start

Create Chatbot

Train with Data

Upload documents or scrape websites to train your chatbot with your content.

Deploy Widget

Generate an API key and add the widget to your website with 2 lines of code.

📖 Table of Contents

Creating Smart Assistants Data Training & Sources Customization & Branding Widget Integration API Usage & Keys Analytics & Sessions

Creating Smart Assistants

🎯 Getting Started

Creating a smart assistant with Jiminy is simple and powerful. Each chatbot is trained on your specific content and can answer questions intelligently.

Key Features:

• AI-powered responses using GPT and Gemini models
• Retrieval-Augmented Generation (RAG) for accurate answers
• Multi-language support (English, Spanish, French, German, and more)
• Real-time chat with conversation memory
• Usage tracking and analytics

🔧 Chatbot Management

Once created, your chatbot has several management tabs:

📊 Data & Retrieval

Upload documents, scrape websites, and manage your chatbot's knowledge base.

💬 Chat Sessions

View conversation history and analyze chat interactions.

🔌 Integrations

Generate API keys and set up website integration.

🎮 Playground

Test your chatbot with live conversations before deployment.

Data Training & Sources

📄 Document Upload

Train your chatbot by uploading various document types. Supported formats include:

Supported Formats:

• PDF documents
• Microsoft Word (.docx)
• Text files (.txt)
• Markdown files (.md)

Processing:

• Automatic text extraction
• Intelligent chunking
• Vector embeddings generation
• Real-time processing status

🌐 Web Scraping

Automatically extract content from websites to train your chatbot:

How Web Scraping Works:

1. Queue Scraping: Submit a URL for secure, asynchronous processing
2. Content Extraction: Advanced scraping extracts meaningful text content
3. Auto-Processing: Content is automatically chunked and embedded
4. Status Tracking: Real-time updates on processing status

⚡ Processing Status

Ready

Document uploaded successfully

Processing

Creating embeddings

Completed

Ready for chat

Failed

Processing error

Customization & Branding

🎨 Visual Customization

Make your chatbot match your brand with extensive customization options:

Appearance Options:

• Primary Color: Custom hex colors for branding
• Position: Bottom-right, bottom-left, top-right, top-left
• Title & Subtitle: Custom greeting text
• Welcome Message: Personalized chat opener
• Font Family: Choose from 8+ professional fonts

Asset Uploads:

• Bubble Logo: Custom chat bubble icon
• Avatar: AI assistant avatar image
• Supported Formats: PNG, JPEG, WebP, SVG
• Optimized Delivery: Fast CDN-cached assets

🌍 Multi-Language Support

Support global audiences with 11+ languages:

European Languages:

🇺🇸 English
🇪🇸 Spanish
🇫🇷 French
🇩🇪 German
🇮🇹 Italian
🇵🇹 Portuguese
🇳🇱 Dutch

Asian Languages:

🇯🇵 Japanese
🇰🇷 Korean
🇨🇳 Chinese

Other Languages:

🇷🇺 Russian

Widget Integration

🚀 Quick Integration

Add your chatbot to any website with just 2 lines of code:

<!-- Add before closing </body> tag -->
<script src="https://jiminy.chat/api/widget"></script>
<script>
  JiminyChatbot.init({
    apiKey: 'jmny_your_api_key_here',
    chatbotId: 'your-chatbot-id-here',
    title: 'Jiminy',
    primaryColor: '#4299e1'
  });
</script>

⚙️ Configuration Options

Required Parameters:

• apiKey - Your chatbot API key
• chatbotId - Unique chatbot identifier

Optional Parameters:

• title - Chat window title
• primaryColor - Brand color
• position - Widget position
• welcomeMessage - Opening message

🎮 JavaScript API

Control your chatbot programmatically with JavaScript functions:

Open Chat

JiminyChatbot.open()

Programmatically open the chat window

Close Chat

JiminyChatbot.close()

Close the chat window

Send Message

JiminyChatbot.sendMessage('Hello!')

Send a pre-filled message

🌐 Cross-Platform Support

Works Everywhere:

• Vanilla HTML/JavaScript
• React, Vue.js, Angular
• WordPress, Shopify

• Static site generators
• Mobile responsive design
• All modern browsers

API Usage & Keys

🔑 API Key Management

Secure your chatbot integration with API keys:

Key Features:

• Unique Keys: Generate multiple keys per chatbot
• Custom Names: Name keys for easy identification
• Usage Tracking: Monitor last used timestamps
• Easy Management: Edit, revoke, or regenerate keys

Domain Security:

• Domain Restrictions: Limit usage to specific domains
• Wildcard Support: Use *.example.com patterns
• Multiple Domains: Allow multiple authorized domains
• Secure by Default: Prevent unauthorized usage

📡 API Endpoints

POST/api/chatbot-response

Send messages and receive AI responses

Parameters: chatbotId, message, apiKey, sessionId (optional), language (optional)

GET/api/widget-config

Get widget configuration and styling

Parameters: chatbotId, apiKey

Analytics & Sessions

📊 Chat Session Analytics

Track and analyze all conversations with detailed session management:

Session Tracking

• Unique session IDs
• User conversation flows
• Message timestamps
• Session duration

Message History

• Full conversation logs
• User questions archive
• AI response quality
• Context understanding

Usage Insights

• Popular questions
• Response accuracy
• User engagement
• Performance metrics

🧪 Testing & Playground

Test your chatbot before deployment with the built-in playground:

Playground Features:

• Live Chat Testing: Real-time conversation with your AI
• Response Quality: Evaluate AI answers before going live
• Edge Case Testing: Test unusual questions and scenarios
• Performance Monitoring: Check response times and accuracy

Need Help Getting Started?

Our team is here to help you create the perfect AI chatbot for your needs. Get personalized support and best practices for your implementation.

Start Building Your Chatbot →