DOCSEARCHbyAlgolia
Submit Docs

CometChat Documentation

website·Indexed 36 days ago

https://www.cometchat.com/docs

Developer guides for integrating real-time chat, voice, and video calling. Includes documentation for the UI Kit Builder (React, Next.js, React Router, Android), Card Builder for interactive messages, AI User Copilot for smart replies and summaries, and the @cometchat/skills-cli for managing AI agent skills.

Tokens
1.6M
Snippets
6.8K
Records
9K
Agent score
72%

What's inside CometChat

  1. Introduction to CometChat Vue UI Kit

    The CometChat Vue UI Kit is a collection of prebuilt, configurable UI components and modules designed to help developers quickly build chat applications with essential messaging and calling features. It acts as an add-on to the CometChat JavaScript SDK; installing the UI Kit automatically installs the core Chat SDK.

  2. Overview of CometChat AI Moderation

    The AI Moderation API allows developers to create and manage rules to maintain a safe environment. It supports real-time evaluation of messages before delivery. Key capabilities include:

    • Text Moderation: Scans for profanity and custom keyword lists (including regex patterns). Violating messages are dropped.
    • AI Image/Video Moderation: Scans attachments and discards messages if violations are found.
    • Automated Actions: When a rule is violated, the message is blocked. Depending on the configuration, the sender can be kicked or banned from groups, or blocked in 1-on-1 conversations.

  3. Overview of MessageTemplateUtils in Flutter UI Kit

    MessageTemplateUtils is a static utility class and central registry in the cometchat_chat_uikit package. It defines how different message types are rendered as bubbles, which options appear on long-press, and which text formatters are applied. It replaces the DataSource / ChatConfigurator pattern used in the Android UI Kit. In v6, CometChatUIKit.getDataSource() has been removed in favor of this utility.
    import 'package:cometchat_chat_uikit/cometchat_chat_uikit.dart';

  4. Overview of CometChat React Native UI Kit

    The CometChat React Native UI Kit provides a set of pre-built components to implement chat layouts, user management, and conversation flows. It is designed to be layered onto an application after the base React Native CLI or Expo integration is complete. The kit allows developers to add complex UX features without rewriting core chat logic.
    # Package name for the React Native UI Kit
npm install @cometchat/chat-uikit-react-native

  5. Overview of CometChat Widget Builder for Squarespace

    CometChat Widget Builder for Squarespace is a no-code solution for embedding a real-time chat and calling interface into any Squarespace website. It allows developers to visually configure themes, colors, typography, and feature toggles in a dashboard, then deploy the widget using a generated embed code snippet. The widget is powered by CometChat's SDK and infrastructure for message transport and scaling.

  6. Overview of CometChat Knowledge Base

    The Knowledge Base is a centralized workspace in the CometChat Dashboard used to collect, index, and govern documents, notes, and integrations that AI agents rely on. It serves as a shared memory for agents, ensuring responses align with domain expertise and policies. Key capabilities include source management (uploading and curating content), status tracking (monitoring indexing progress), and granular attachments (linking specific sources to specific agents without duplicating data).

  7. Overview of CometChat BYO Agent APIs

    The BYO (Bring Your Own) Agent APIs enable the creation and management of AI agents that integrate with external third-party frameworks such as Vercel AI SDK, LangGraph, CrewAI, Mastra, AG2, Agno, and AG-UI. These APIs provide three primary functional areas:

    1. Third-Party Agents: Endpoints to list, update, and delete agents that delegate tasks to external AI frameworks.
    2. Tools: Endpoints to create, update, and manage custom tools available for BYO agents.
    3. Integrations: Endpoints to retrieve the list of AI framework integrations supported by CometChat.

  8. Overview of CometChat AI User Copilot for Flutter

    CometChat AI provides a user copilot for Flutter applications to enhance messaging experiences. Available features include conversation starters, conversation summaries, smart replies, and writing assistance.

  9. Overview of CometChat Android UI Kit Modules

    The CometChat Android UI Kit provides pre-built UI components for chat functionality. It is available in two distinct modules depending on the UI framework being used:

    • chatuikit-kotlin: Traditional XML-based Views designed for use with Activities and Fragments.
    • chatuikit-compose: Declarative UI components built with Jetpack Compose.
    // Kotlin XML Views
implementation "com.cometchat:chatuikit-kotlin-android"

// Jetpack Compose
implementation "com.cometchat:chatuikit-compose-android"

  10. Overview of Variables in Agent Builder

    Variables allow agents to access dynamic, contextual data during conversations. They can be used to inject user information, custom values, or external data into agent instructions and API tool configurations to make responses personalized and context-aware.

  11. Overview of CometChat Calls SDK

    CometChat Calls is a WebRTC-powered SDK that allows developers to integrate high-quality, real-time voice and video calling into their applications. It provides drop-in UI components (pre-built call screens, controls, and participant views) to minimize UI development effort and ensures consistent API patterns across different platforms.

  12. Overview of Group Chat components in Angular UIKit

    The CometChat Angular UIKit provides built-in components for managing group lists and members. Note that some advanced management components are provided as reference implementations in the sample app and are not part of the core @cometchat/chat-uikit-angular package.
    // Core UIKit Components
- <cometchat-groups>: Displays and manages group lists
- <cometchat-group-members>: Displays and manages group member lists

// Sample App Reference Components (Build your own using SDK)
- <cometchat-create-group>: Creates new groups
- <cometchat-add-members>: Adds members to groups
- <cometchat-banned-members>: Manages banned members
- <cometchat-transfer-ownership>: Transfers group ownership