# ChatBotKit Manuals Index

Comprehensive product documentation and technical references.

- [Docs and Manuals](/manuals/docs-and-manuals.md) - Fetch docs and manuals available on the platform with optional search and filtering.
- [API](/manuals/api.md) - The ChatBotKit REST API provides programmatic access to create, manage, and interact with conversational AI resources including bots, datasets, conversations, and more.
- [Audit Logs](/manuals/audit-logs.md) - Audit logs provide comprehensive tracking of all actions and changes made within your ChatBotKit account, enabling security monitoring, compliance auditing, and activity analysis across all resources and operations.
- [Authentication](/manuals/authentication.md) - Comprehensive guide to authenticating with the ChatBotKit API using secret keys, JWT tokens, and user impersonation for secure programmatic access.
- [Blueprints](/manuals/blueprints.md) - Blueprints are organizational containers that group related resources like bots, datasets, skillsets, and integrations into reusable templates, enabling efficient management and sharing of complex conversational AI configurations.
- [Bot Memories](/manuals/bot-memories.md) - Bot memories store information learned from conversations, enabling bots to recall past interactions and maintain context across sessions for more intelligent and personalized responses.
- [Bot Ratings](/manuals/bot-ratings.md) - Bot ratings enable you to record feedback and performance metrics for conversational AI agents, providing a structured way to track quality, measure user satisfaction, and identify areas for improvement over time.
- [Bot Sessions](/manuals/bot-sessions.md) - Bot sessions provide secure, time-limited authentication tokens for conversational interactions, enabling users to engage with bots through applications, websites, and third-party platforms without exposing full API credentials.
- [Bots](/manuals/bots.md) - Bots are intelligent conversational agents that can interact with users, answer questions, and perform tasks using AI models and connected resources like datasets and skillsets.
- [Channels](/manuals/channels.md) - Learn about publishing messages to channels for remote function calling in conversational AI and more.
- [Contacts](/manuals/contacts.md) - Contacts represent end-users or customers who interact with your chatbots, enabling conversation tracking, contact management, and personalized user experiences.
- [Conversations](/manuals/conversations.md) - Conversations are interactive sessions where messages are exchanged between users and AI bots, enabling rich dialogue experiences with context awareness, memory, and intelligent responses.
- [Dataset Files](/manuals/dataset-files.md) - Dataset files enable you to attach uploaded files to datasets, automatically extracting and indexing their content for AI-powered search and retrieval, supporting various document formats including PDFs, text files, and office documents.
- [Dataset Records](/manuals/dataset-records.md) - Dataset records are individual entries within a dataset that contain specific pieces of information used to provide context and knowledge to the agent.
- [Dataset Search](/manuals/dataset-search.md) - Datasets provide powerful semantic search capabilities to find relevant information based on natural language queries, enabling your bots to retrieve contextually appropriate knowledge from large knowledge bases.
- [Datasets](/manuals/datasets.md) - Datasets are structured collections of data that serve as knowledge bases for various applications, enabling efficient storage, retrieval, and management of information.
- [Discord Integration](/manuals/discord-integration.md) - Discord Integration enables you to connect ChatBotKit with Discord, allowing you to deploy conversational AI bots directly in Discord servers through slash commands and interactive messages.
- [Event Logs](/manuals/event-logs.md) - Event logs provide comprehensive tracking and auditing of system activities, resource interactions, and integration events, enabling monitoring, debugging, compliance, and analytics capabilities across the ChatBotKit platform.
- [Event Metrics](/manuals/event-metrics.md) - Event metrics provide aggregated, time-series analytics data about platform usage, resource consumption, and system activity, enabling detailed performance monitoring, capacity planning, billing analysis, and operational insights across conversations, integrations, and AI model usage.
- [Files](/manuals/files.md) - Comprehensive guide to managing files in the platform, including uploading, retrieving, updating, and deleting file resources.
- [Google Chat Integration](/manuals/google-chat-integration.md) - Integrate ChatBotKit with Google Chat to deploy intelligent AI agents directly within Google Workspace spaces, enabling seamless collaboration through direct messages and space conversations.
- [GraphQL](/manuals/graphql.md) - The GraphQL API provides a flexible, powerful interface for querying and manipulating platform resources using a single endpoint with strongly-typed schemas.
- [Memories](/manuals/memories.md) - Memories are persistent data storage units that enable applications to store and retrieve information associated with bots and contacts, providing context and historical data for intelligent interactions.
- [Messenger Integration](/manuals/messenger-integration.md) - Integrate ChatBotKit with Facebook Messenger to deploy conversational AI that engages with your Messenger audience through automated responses, natural language understanding, and seamless conversation management.
- [Partner Users](/manuals/partner-users.md) - Partner users are sub-accounts that can be created and managed by partner accounts, enabling white-label SaaS solutions where each customer operates in an isolated environment with custom configurations and restrictions.
- [Policies](/manuals/policies.md) - Policies define automated rules and governance for data management, including retention, archival, and compliance operations across conversations, messages, and other platform resources.
- [Portals](/manuals/portals.md) - Developer reference for portal configuration, including config shape, app options, user access matchers, and update behavior.
- [Ratings](/manuals/ratings.md) - Ratings are structured feedback records that track quality metrics and user satisfaction for bots, conversations, and messages, providing quantitative and qualitative data for performance analysis and improvement.
- [Reports](/manuals/reports.md) - Analytics reports provide comprehensive insights into your platform usage, including metrics on conversations, messages, ratings, contacts, and agent activities across customizable time periods.
- [Secrets](/manuals/secrets.md) - Secrets are secure credential storage for API keys, OAuth tokens, and other sensitive authentication data used by agents and integrations within the platform.
- [Slack Integration](/manuals/slack-integration.md) - Integrate ChatBotKit with Slack to deploy intelligent AI agents directly within your Slack workspace, enabling seamless team collaboration through channels, direct messages, and slash commands.
- [Tasks](/manuals/tasks.md) - Tasks are scheduled or on-demand actions that your agents can perform automatically, enabling workflow automation and periodic operations.
- [Teams Integration](/manuals/teams-integration.md) - Teams Integration enables you to connect ChatBotKit with
- [Teams](/manuals/teams.md) - Teams enable collaborative resource management by allowing you to organize and share bots, datasets, integrations, and other platform resources with groups of users who work together on projects.
- [Usage](/manuals/usage.md) - Usage statistics provide comprehensive visibility into your platform consumption, including token usage, conversation counts, message volumes, and database resource allocation for the current billing period.
- [Widget Integration](/manuals/widget-integration.md) - Widget integrations enable you to embed conversational AI directly into websites and web applications through a customizable chat interface that adapts to your brand, supports rich interactions, and provides seamless user experiences across desktop and mobile devices.
- [Dispatching Conversations](/manuals/dispatching-conversations.md) - Learn about running conversation completions in the background using the dispatch endpoint.
- [Partner Tokens](/manuals/partner-tokens.md) - Partner tokens are API authentication tokens created for partner users (sub-accounts), enabling secure programmatic access to the ChatBotKit platform on behalf of specific customer accounts within a partner's white-label solution.
- [Dispatching Stateful Conversations](/manuals/dispatching-stateful-conversations.md) - Learn about running stateful conversation completions in the background using the dispatch endpoint.
- [Language Models](/manuals/language-models.md) - Comprehensive guide to understanding language model configuration in the ChatBotKit platform
- [Skillsets](/manuals/skillsets.md) - Skillsets are collections of abilities that define what actions your AI agents can perform, from fetching web data to sending emails and generating content.
- [Skillset Abilities](/manuals/skillset-abilities.md) - Abilities are the individual actions that skillsets can perform, defined through natural language instructions and executable code blocks.
- [Email Integration](/manuals/email-integration.md) - Email Integration enables your chatbot to interact with users through email, providing a dedicated inbox for automated email responses and support.
- [Image Models](/manuals/image-models.md) - Comprehensive guide to understanding image model configuration and pricing in the ChatBotKit platform
- [Partner User Contexts](/manuals/partner-user-contexts.md) - Partner user contexts associate a partner sub-account with specific platform resources such as blueprints, bots, datasets, and skillsets, enabling scoped AI experiences with optional custom payload data.
- [Platform Abilities](/manuals/platform-abilities.md) - Abilities are reusable, configurable capabilities that extend the functionality of conversational AI agents, enabling them to perform specialized tasks and interact with external services.
- [Resource Limits](/manuals/resource-limits.md) - Resource limits control usage quotas and constraints for accounts, defining maximum allocations for various platform resources and operations.
- [Platform Actions](/manuals/platform-actions.md) - Actions are fundamental operations that conversational AI agents can perform, providing a standardized way to execute common tasks and behaviors within conversations.
- [Platform Models](/manuals/platform-models.md) - Language models are the AI engines that power conversational experiences, with each model offering different capabilities, performance characteristics, and token limits.
- [Platform Secrets](/manuals/platform-secrets.md) - Secrets are secure credential types that the platform supports for authenticating with external services and APIs, enabling secure integration with third-party systems.
- [Contact Association](/manuals/contact-association.md) - Learn how to associate conversations and interactions with contacts using either existing contact IDs or automatic contact creation via fingerprints.
- [Conversation Attachments](/manuals/conversation-attachments.md) - Conversation attachments enable users to upload files, images, and documents to conversations, enriching interactions with visual and textual context that can be processed by AI models.
- [Metadata](/manuals/metadata.md) - Metadata provides a flexible way to attach custom information to platform resources, enabling integrations, tracking, and custom workflows without modifying core data structures.
- [Spaces](/manuals/spaces.md) - Spaces are collaborative environments that enable teams to organize and manage conversations, contacts, and shared resources in isolated workspaces.
- [Support Integration](/manuals/support-integration.md) - Support integrations enable automated customer support workflows by connecting AI chatbots with support systems like Zendesk, Intercom, and email platforms, automatically extracting customer information and routing conversations.
- [Space Storage](/manuals/space-storage.md) - Space storage provides file management capabilities within spaces, enabling secure file uploads, downloads, and organization with flexible path-based addressing.
- [Conversation Feedback](/manuals/conversation-feedback.md) - The rating system allows users to provide feedback on individual messages within a conversation by upvoting or downvoting them. This feedback mechanism helps improve the quality of AI-generated responses by identifying which messages are helpful and which are not. Users can specify a value for their rating, with upvotes being positive values and downvotes being negative values. Additionally, users can provide a reason for their rating, which can be used to further analyze and enhance the AI's performance.
- [Conversation Sessions](/manuals/conversation-sessions.md) - Conversation sessions provide secure, time-limited tokens that allow client-side applications to interact directly with conversations without exposing your API credentials.
- [Instruction Types](/manuals/instruction-types.md) - Instruction types define how user input is interpreted and transformed into executable actions within the ChatBotKit platform, enabling flexible and powerful agent behaviors through different instruction patterns.
- [Platform Examples](/manuals/platform-examples.md) - Examples are pre-built templates and configurations that demonstrate common conversational AI use cases, providing starting points for building your own applications.
- [Telegram Integration](/manuals/telegram-integration.md) - Telegram integration allows you to connect ChatBotKit with Telegram bots, enabling powerful conversational AI experiences directly within Telegram messaging platform for individuals and businesses.
- [Trigger Integration](/manuals/trigger-integration.md) - Trigger Integrations enable powerful event-driven workflows by allowing your applications to send events and information to bots through a dedicated API endpoint, with the bot processing events in the background and executing appropriate actions.
- [Usage Statistics](/manuals/usage-statistics.md)
- [WhatsApp Integration](/manuals/whatsapp-integration.md) - WhatsApp Integration enables you to connect your conversational AI with the WhatsApp Business platform, allowing you to engage with users through one of the world's most popular messaging applications.
- [Instagram Integration](/manuals/instagram-integration.md) - Instagram Integration enables you to connect your conversational AI with the Instagram Messaging platform, allowing you to engage with users through Instagram Direct Messages.
- [Bot Usage Statistics](/manuals/bot-usage-statistics.md) - Bot usage statistics provide detailed insights into resource consumption, conversation volumes, and message activity for individual bots, enabling you to monitor performance, track costs, and optimize bot operations over time.
- [Contact Secrets](/manuals/contact-secrets.md) - Contact secrets provide secure authentication mechanisms for external service integrations, enabling contacts to connect their third-party accounts with AI agents through OAuth and API key authentication flows.
- [Notion Integration](/manuals/notion-integration.md) - Connect your Notion workspace to ChatBotKit to automatically sync pages and databases into datasets, enabling your AI agents to access and search your Notion content.
- [Platform Documentation](/manuals/platform-documentation.md) - The platform documentation system provides comprehensive guides, tutorials, and reference materials that help developers build and deploy conversational AI applications.
- [Sitemap Integration](/manuals/sitemap-integration.md) - Automatically crawl and sync website content into datasets by providing a sitemap URL, enabling your AI agents to search and reference web content in conversations.
- [Blueprint Resources](/manuals/blueprint-resources.md) - Blueprint resources represent the collection of related components (bots, datasets, skillsets, integrations, etc.) that are organized within a blueprint, providing a comprehensive view of all assets in a specific configuration.
- [Agent Introspection](/manuals/agent-introspection.md) - Agent introspection enables AI agents to discover and query the resources available within their blueprint context, allowing them to dynamically adapt their behavior and make intelligent decisions about resource utilization at runtime.
- [Conversation Contacts](/manuals/conversation-contacts.md) - Conversation contacts enable you to track and associate user information with conversations, providing context for interactions and enabling personalized experiences across multiple conversations.
- [Conversation Usage Statistics](/manuals/conversation-usage-statistics.md) - Conversation usage statistics provide granular insights into token consumption and message activity at the individual conversation level, enabling detailed analysis of resource usage, cost attribution, and interaction patterns for specific user sessions.
- [MCP Server Integration](/manuals/mcp-server-integration.md) - MCP (Model Context Protocol) Server Integration enables you to expose your ChatBotKit skillsets as MCP-compliant servers that external applications and AI systems can connect to and utilize.
- [Platform Manuals](/manuals/platform-manuals.md) - Platform manuals provide detailed operational guides and API reference documentation that explain how to use specific platform features, resources, and endpoints.
- [Platform Tutorials](/manuals/platform-tutorials.md) - The platform tutorial system provides step-by-step guides and practical examples that help developers build and deploy conversational AI applications.
- [Platform Guides](/manuals/platform-guides.md) - The platform guide system provides comprehensive, in-depth guides that help developers understand and implement conversational AI solutions.
- [Conversation Cleanup](/manuals/conversation-cleanup.md) - Learn how conversations are automatically cleaned up through expiry and empty conversation retention policies.
- [Task Execution](/manuals/task-execution.md)
- [Conversation Messages](/manuals/conversation-messages.md) - Messages are individual units of communication within a conversation, representing either user inputs or AI responses, and can be created, retrieved, updated, or deleted to manage conversation content.
- [Twilio Integration](/manuals/twilio-integration.md) - Twilio Integration enables your ChatBotKit bots to communicate with users through SMS text messaging via Twilio's powerful telecommunications platform.
- [Conversation Flow](/manuals/conversation-flow.md) - Managing conversation workflows including stateless and stateful interaction patterns for different use cases and integration scenarios.
- [Aliases](/manuals/aliases.md) - Resource aliases provide human-readable identifiers for ChatBotKit resources, enabling easier reference and management.
- [Extract Integration](/manuals/extract-integration.md) - The Extract Integration enables automated data extraction from conversations using custom JSON schemas, allowing you to capture structured information from user interactions.
- [Agent SDK](/manuals/agent-sdk.md) - This page provides a comprehensive guide to the ChatBotKit Agent SDK, detailing key features, installation instructions, tool creation, execution modes, and best practices for building autonomous AI agents that combine custom tools with ChatBotKit platform capabilities.
- [CLI](/manuals/cli.md) - Comprehensive guide to the ChatBotKit CLI featuring autonomous agent mode for local file system operations, coding assistance, business automation workflows, and complete API management capabilities.
- [Go SDK](/manuals/go-sdk.md) - Comprehensive guide to the ChatBotKit Go SDK for building conversational AI applications with streaming support, agent execution, and tool integration.
- [MCP](/manuals/mcp.md) - This page provides comprehensive documentation for the ChatBotKit Model Context Protocol (MCP) server, including what MCP is, how it works, setup instructions for various AI assistants, available tools and capabilities, authentication, and usage examples.
- [Next SDK](/manuals/next-sdk.md) - This page provides detailed documentation for the Chatbotkit Next.js SDK, outlining its key features, installation instructions, server-side integration, best practices, TypeScript support, and examples for implementing AI-powered chat capabilities in Next.js applications.
- [Node SDK](/manuals/node-sdk.md) - Comprehensive guide to the ChatBotKit Node.js SDK for building conversational AI applications with streaming support, TypeScript integration, and advanced features.
- [Partner Sessions](/manuals/partner-sessions.md)
- [Primers](/manuals/primers.md) - This page provides an overview of primers for developers new to ChatBotKit and conversational AI software, including detailed examples, projects, and applications. It serves as a comprehensive resource for understanding and implementing conversational AI solutions.
- [React SDK](/manuals/react-sdk.md) - The React SDK documentation provides comprehensive guidance on utilizing the Chatbotkit React SDK, including installation instructions, detailed explanations of components and hooks, and practical examples for building responsive chat interfaces.
- [Starter Templates](/manuals/starter-templates.md) - ChatBotKit provides a collection of production-ready starter templates for building AI-powered applications. Each template includes authentication, platform integration, and modern UI components, giving you a fully functional starting point for common use cases.
- [Streaming](/manuals/streaming.md) - Learn how to use streaming responses with the ChatBotKit API to efficiently handle large datasets, long-running operations, and real-time updates by controlling the Accept header in your requests.
- [Terraform Provider](/manuals/terraform-provider.md) - Comprehensive guide to the ChatBotKit Terraform Provider for managing AI chatbot infrastructure as code with full resource support and automated deployments.