# ChatBotKit

> ChatBotKit is an AI agent infrastructure platform for building, deploying, and operating production AI agents. It unifies agents, data, integrations, security, and observability in one place, supports any AI model from any vendor, and gives developers both a visual Blueprint designer and code-first SDKs to ship real agentic work.

ChatBotKit lets developers compose AI agents from reusable building blocks - datasets, abilities, and integrations - then deploy them across web widgets, apps, Slack, Discord, WhatsApp, Telegram, and custom interfaces. Agents reason, plan, and execute multi-step tasks autonomously: resolving tickets, qualifying leads, processing documents, calling tools, and completing work using your data and systems. The platform handles tool calling, RAG, streaming, guardrails, and monitoring so teams skip months of infrastructure and go straight to production.

Key capabilities include:
- Agentic AI: agents that reason, plan, and execute multi-step tasks with tools and data
- Tool calling and MCP: connect agents to APIs, databases, and internal tools with built-in OAuth and Model Context Protocol support
- Multi-model support (OpenAI, Anthropic, Google, Meta, and more) - bring any model or your own
- Knowledge bases and RAG with dataset integration (PDF, DOCX, CSV, JSON, text files)
- Skillsets and abilities for extending agents with custom functions
- Multi-channel deployment with embeddable widgets and messaging integrations
- Built-in guardrails: content moderation, PII filtering, and compliance controls
- Observability and governance: monitor every conversation, track agent performance, debug at scale
- Enterprise security and GDPR/CCPA compliance
- Partner API for white-label and multi-tenant applications

## Content Indexes

- [Documentation Index](https://chatbotkit.com/docs/index.md): Complete list of all documentation articles
- [Manuals Index](https://chatbotkit.com/manuals/index.md): Complete list of all technical manuals
- [Tutorials Index](https://chatbotkit.com/tutorials/index.md): Complete list of all tutorials

## Getting Started

- [Introduction](https://chatbotkit.com/docs/introduction.md): Core concepts including backstories, models, datasets, skillsets, and integrations
- [API Documentation](https://chatbotkit.com/docs/api.md): Comprehensive API reference with authentication and endpoint details
- [API Specification](https://chatbotkit.com/api/v1/spec.json): Full OpenAPI v3 specification for the ChatBotKit API

## Core Concepts

- [Backstories](https://chatbotkit.com/docs/backstories.md): Defining agent personality, context, instructions, and capabilities
- [Models](https://chatbotkit.com/docs/models.md): Understanding and selecting AI models
- [Bots](https://chatbotkit.com/docs/bots.md): Creating and managing AI agents
- [Datasets](https://chatbotkit.com/docs/datasets.md): Managing knowledge bases and RAG data sources
- [Skillsets](https://chatbotkit.com/docs/skillsets.md): Extending agents with custom abilities, tool calling, and function calling
- [Conversations](https://chatbotkit.com/docs/conversations.md): Managing agent interactions and session state

## Manuals - Technical Reference Documentation

Comprehensive technical manuals provide detailed reference documentation for all platform features and capabilities:

- [Authentication](https://chatbotkit.com/manuals/authentication.md): API authentication methods and security
- [Bots](https://chatbotkit.com/manuals/bots.md): Complete agent configuration and management reference
- [Blueprints](https://chatbotkit.com/manuals/blueprints.md): Designing reusable AI agent templates with the visual Blueprint designer
- [Starter Templates](https://chatbotkit.com/manuals/starter-templates.md): Pre-built agent templates to get to production fast
- [Datasets](https://chatbotkit.com/manuals/datasets.md): Dataset creation, file management, and search operations
- [Skillsets](https://chatbotkit.com/manuals/skillsets.md): Building and managing skillsets with abilities and tool calling
- [MCP](https://chatbotkit.com/manuals/mcp.md): Model Context Protocol support for connecting agents to external tools
- [Channels](https://chatbotkit.com/manuals/channels.md): Deploying agents across messaging and web channels
- [Conversations](https://chatbotkit.com/manuals/conversations.md): Managing agent conversation state and messages
- [Node.js SDK](https://chatbotkit.com/manuals/node-sdk.md): Official Node.js SDK documentation
- [Agent SDK](https://chatbotkit.com/manuals/agent-sdk.md): Official Agent SDK documentation
- [React SDK](https://chatbotkit.com/manuals/react-sdk.md): React components and hooks reference
- [Next SDK](https://chatbotkit.com/manuals/next-sdk.md): Next.js integration documentation

## REST API for Content Discovery

ChatBotKit provides REST API endpoints for programmatically discovering and accessing documentation and manuals:

### List Available Manuals

```
GET https://chatbotkit.com/api/v1/platform/manual/list
```

Returns a complete list of available technical manuals with metadata including:
- Manual ID, title, and description
- Category and tags for filtering
- Creation and update timestamps
- Display order index

Example response structure:
```json
{
  "items": [
    {
      "id": "authentication",
      "name": "Authentication",
      "description": "API authentication methods and security",
      "category": null,
      "tags": [],
      "index": 1,
      "createdAt": 1696118400000,
      "updatedAt": 1696118400000
    }
  ]
}
```

### Fetch Individual Manual

```
GET https://chatbotkit.com/api/v1/platform/manual/{manualId}/fetch
```

Retrieves the full content of a specific manual by ID.

For example, to fetch the "datasets" manual:

```
GET https://chatbotkit.com/api/v1/platform/manual/datasets/fetch
```

### Search Manuals

Performs semantic search across all manuals using vector embeddings. Returns ranked results with similarity scores.

```
POST https://chatbotkit.com/api/v1/platform/manual/search
Content-Type: application/json

{
  "search": "your search query"
}
```

Response includes similarity scores for ranking search results (top 10 results returned).

### List Available Docs

```
GET https://chatbotkit.com/api/v1/platform/doc/list
```

Returns a complete list of available documentation articles with similar metadata structure.

### Fetch Individual Doc

```
GET https://chatbotkit.com/api/v1/platform/doc/{docId}/fetch
```

Retrieves the full content of a specific documentation article by ID.

For example, to fetch the "datasets" doc:

```
GET https://chatbotkit.com/api/v1/platform/doc/datasets/fetch
```

### Search Docs

Performs semantic search across all documentation using vector embeddings. Returns ranked results with similarity scores.

```
POST https://chatbotkit.com/api/v1/platform/doc/search
Content-Type: application/json

{
  "search": "your search query"
}
```

Response includes similarity scores for ranking search results (top 10 results returned).

### List Available Tutorials

```
GET https://chatbotkit.com/api/v1/platform/tutorial/list
```

Returns a complete list of available tutorials with similar metadata structure.

### Fetch Individual Tutorial

```
GET https://chatbotkit.com/api/v1/platform/tutorial/{tutorialId}/fetch
```

Retrieves the full content of a specific tutorial by ID.

For example, to fetch a specific tutorial:

```
GET https://chatbotkit.com/api/v1/platform/tutorial/getting-started/fetch
```

### Search Tutorials

Performs semantic search across all tutorials using vector embeddings. Returns ranked results with similarity scores.

```
POST https://chatbotkit.com/api/v1/platform/tutorial/search
Content-Type: application/json

{
  "search": "your search query"
}
```

Response includes similarity scores for ranking search results (top 10 results returned).

## SDKs and Integration

- [Node.js SDK](https://chatbotkit.com/docs/node-sdk.md): Official SDK for Node.js applications
- [Agent SDK](https://chatbotkit.com/manuals/agent-sdk.md): Code-first SDK for building and orchestrating AI agents
- [React SDK](https://chatbotkit.com/manuals/react-sdk.md): React components and hooks for building agent interfaces
- [Next.js SDK](https://chatbotkit.com/manuals/next-sdk.md): Server and client components for Next.js applications
- [Go SDK](https://chatbotkit.com/docs/go-sdk.md): Official SDK for Go applications and services
- [Python SDK](https://pypi.org/project/chatbotkit/): Official async Python SDK (`pip install chatbotkit`)
- [Widget SDK](https://chatbotkit.com/docs/widget-sdk.md): Embeddable agent widget for any website or app
- [CLI](https://chatbotkit.com/manuals/cli.md): Manage agents and platform resources from the command line
- [Terraform Provider](https://chatbotkit.com/docs/terraform-provider.md): Provision and manage ChatBotKit resources as infrastructure-as-code

## Model Context Protocol (MCP)

ChatBotKit runs a hosted MCP server so MCP-compatible clients (Claude Desktop, Claude Code, Cursor, VS Code, and others) can search documentation and operate platform resources directly.

- [MCP Manual](https://chatbotkit.com/manuals/mcp.md): Using Model Context Protocol with ChatBotKit agents
- [MCP Setup Guide](https://mcp.cbk.ai/llms.txt): Client configuration for Claude Desktop, Claude Code, Cursor, VS Code, and more
- MCP Server URL: `https://mcp.cbk.ai/mcp`

## Optional

- [Type Documentation](https://chatbotkit.github.io/node-sdk/llms.txt): Full TypeScript definitions
- [GitHub Repository](https://github.com/chatbotkit/node-sdk): Source code and examples (see https://raw.githubusercontent.com/chatbotkit/node-sdk/refs/heads/main/README.md)
- [Changelog](https://chatbotkit.com/changelog): Latest updates and releases
- [Discord Community](https://go.cbk.ai/discord): Connect with other developers