ChatBotKit Node SDK
    Preparing search index...

    Module @chatbotkit/sdk

    Follow on Twitter ChatBotKit CBK.AI NPM Email Discord

    ChatBotKit Node SDK

    Welcome to the ChatBotKit Node SDK. This is a Node.js-based solution designed to simplify the process of building conversational AI chatbots. Utilize ChatBotKit to rapidly develop and deploy AI bots capable of natural language interactions.

    Embark on creating your chatbot with ChatBotKit in a few easy steps:

    1. Installation: To integrate the SDK into your project, use npm:
      npm install @chatbotkit/sdk
      
    2. Implementation: Start using the SDK to build and manage your chatbot.

    Below is a straightforward example demonstrating how to implement streaming with the SDK in both Edge and Serverless environments:

    import { ConversationClient } from '@chatbotkit/sdk/conversation/index.js'

    // Initialize the ConversationClient
    const client = new ConversationClient({
    /* configuration options */
    })

    // Stream messages using the ConversationClient
    for await (const { type, data } of client
    .complete(null, { model: 'gpt-5-mini', messages })
    .stream()) {
    if (type === 'token') {
    process.stdout.write(data.token)
    }
    }

    // Additional processing can be added here

    Explore a detailed example with more advanced features here.

    For an in-depth exploration of the ChatBotKit Node SDK, including insights into its capabilities and configurations for different environments, visit our type documentation page.

    Encountered a bug or interested in contributing? Your participation is highly appreciated! Feel free to open an issue or submit a pull request on our official GitHub repository.

    • FormShare - Bring your forms to life with generative UI.
    • PeopleAI - Experience history like never before with our AI chatbots.

    Modules

    blueprint
    blueprint/v1
    bot
    bot/session
    bot/session/v1
    bot/v1
    channel
    channel/v1
    client
    contact
    contact/conversation
    contact/conversation/v1
    contact/secret
    contact/secret/v1
    contact/space
    contact/space/v1
    contact/task
    contact/task/v1
    contact/v1
    conversation
    conversation/attachment
    conversation/attachment/v1
    conversation/message
    conversation/message/v1
    conversation/session
    conversation/session/v1
    conversation/v1
    dataset
    dataset/file
    dataset/file/v1
    dataset/record
    dataset/record/v1
    dataset/v1
    file
    file/v1
    graphql
    graphql/v1
    index
    integration/discord
    integration/discord/v1
    integration/email
    integration/email/v1
    integration/extract
    integration/extract/v1
    integration/mcpserver
    integration/mcpserver/v1
    integration/messenger
    integration/messenger/v1
    integration/notion
    integration/notion/v1
    integration/sitemap
    integration/sitemap/v1
    integration/slack
    integration/slack/v1
    integration/support
    integration/support/v1
    integration/telegram
    integration/telegram/v1
    integration/trigger
    integration/trigger/v1
    integration/twilio
    integration/twilio/v1
    integration/whatsapp
    integration/whatsapp/v1
    integration/widget
    integration/widget/v1
    magic
    magic/v1
    memory
    memory/v1
    model/v1
    partner
    partner/user
    partner/user/token
    partner/user/token/v1
    partner/user/v1
    platform
    platform/ability
    platform/ability/v1
    platform/action
    platform/action/v1
    platform/doc
    platform/doc/v1
    platform/example
    platform/example/v1
    platform/manual
    platform/manual/v1
    platform/model
    platform/model/v1
    platform/report
    platform/report/v1
    platform/secret
    platform/secret/v1
    platform/tutorial
    platform/tutorial/v1
    policy
    policy/v1
    portal
    portal/v1
    report
    report/v1
    secret
    secret/v1
    skillset
    skillset/ability
    skillset/ability/v1
    skillset/v1
    space
    space/v1
    task
    task/v1
    team
    team/v1
    usage
    usage/series
    usage/series/v1
    usage/v1