<DOCS />

Complete technical reference for building with Jiminy

QUICK_START

1

CREATE_CHATBOT

Sign up and create your first AI assistant

2

UPLOAD_DOCUMENTS

Upload PDF or TXT files to train your chatbot

3

DEPLOY_WIDGET

Generate API key and embed 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 advanced language models
  • Context-aware conversations with memory retention
  • Multi-language support (11+ languages)
  • Real-time chat with conversation memory
  • Usage tracking and analytics

CHATBOT_MANAGEMENT

Once created, your chatbot has several management tabs:

DATA_RETRIEVAL

Upload documents and manage knowledge base

CHAT_SESSIONS

View conversation history and analyze interactions

INTEGRATIONS

Generate API keys and set up website integration

PLAYGROUND

Test chatbot with live conversations

DATA_TRAINING_SOURCES

DOCUMENT_UPLOAD

Train your chatbot by uploading documents. Supported formats:

SUPPORTED_FORMATS:

  • • PDF documents
  • • Text files (.txt)

PROCESSING:

  • • Automatic text extraction
  • • Intelligent chunking
  • • Vector embeddings generation
  • • Real-time 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
  • • 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:
  • EN, ES, FR, DE, IT, PT, NL
ASIAN:
  • JA, KO, ZH
OTHER:
  • RU

WIDGET_INTEGRATION

QUICK_INTEGRATION

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

integration.js
<!-- 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'
  });
</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:

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

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.