Getting Started #

Welcome to Canny Bot! This guide will help you get up and running with our two main features: the Chat Widget and Semantic Search API.

What is Canny Bot? #

Canny Bot is an AI-powered platform that enables you to:

• Embed a chat widget on your website for instant customer support
• Search your knowledge base using semantic understanding
• Generate AI answers based on your documents

Quick Start #

1. Authentication #

All API endpoints require authentication. You can authenticate using any of these methods:

• API Key (Query Parameter): Include as a query parameter

  ?api_key=<your_api_key>
  

• API Key (Header): Include in the x-api-key header

  x-api-key: <your_api_key>
  

2. Core Features #

• Chat Widget: Embed on your website with a single script tag
• Semantic Search: Query your knowledge base with natural language
• Streaming Responses: Get real-time answers with SSE streaming

Next Steps #

• Chat Widget Documentation
• Semantic Search API
• API Reference