botserver/docs
2025-12-12 12:35:40 -03:00
..
api Add balanced documentation structure 2025-12-04 12:44:18 -03:00
guides feat(email): implement email read tracking with pixel support 2025-12-04 18:15:09 -03:00
reference Update: General project updates 2025-12-06 11:09:12 -03:00
AUTO_TASK_ARCHITECTURE.md docs: Add Auto Task Architecture documentation 2025-12-12 12:35:40 -03:00
README.md Add balanced documentation structure 2025-12-04 12:44:18 -03:00

General Bots Documentation

Welcome to the General Bots documentation. This guide covers everything you need to build, deploy, and manage AI-powered bots.

Quick Navigation

Section Description
Getting Started Installation and first bot
API Reference REST endpoints and WebSocket
BASIC Language Dialog scripting reference
Configuration Environment and settings

Documentation Structure

docs/
├── api/                    # API documentation
│   ├── README.md           # API overview
│   ├── rest-endpoints.md   # HTTP endpoints
│   └── websocket.md        # Real-time communication
├── guides/                 # How-to guides
│   ├── getting-started.md  # Quick start
│   ├── deployment.md       # Production setup
│   └── templates.md        # Using templates
└── reference/              # Technical reference
    ├── basic-language.md   # BASIC keywords
    ├── configuration.md    # Config options
    └── architecture.md     # System design

Core Concepts

Knowledge Bases (KB)

Store documents, FAQs, and data that the AI can search and reference:

USE KB "company-docs"

Tools

Functions the AI can call to perform actions:

USE TOOL "send-email"
USE TOOL "create-ticket"

Dialogs

BASIC scripts that define conversation flows and automation:

TALK "Hello! How can I help?"
answer = HEAR

Version

This documentation covers General Bots v6.x.