Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to ChatBotKit

Scalekit connector
Open markdown

The ChatBotKit connector lets your AI agent act in each user's ChatBotKit account. Each user connects their own ChatBotKit access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

Tools
59
What they doRead · write · destructive
27 · 24 · 827 read24 write8 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the ChatBotKit connection

    In AgentKit > Connections, create a ChatBotKit connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'chatbotkit'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize ChatBotKit:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'chatbotkit_blueprints_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their ChatBotKit credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • chatbotkit_blueprint_getGet one blueprint.Read-only

    Get Blueprint

    Get one blueprint. Returns an object with alias, name, description, meta, id, createdAt, updatedAt, contactId, visibility. Use chatbotkit_blueprint_get for one blueprint.

    Inputs

    blueprint_idstringrequired
    Blueprint ID to group the resource under. Example: cm1a2b3c4d5e6f7g8h9i0j1k
  • chatbotkit_blueprints_listList blueprints (groups of related bots, datasets and skillsets).Read-only

    List Blueprints

    List blueprints (groups of related bots, datasets and skillsets). Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, contactId) plus cursor. Use chatbotkit_blueprints_list to find a blueprint ID.

    Inputs

    contact_idstring
    Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    cursorstring
    Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    metastring
    Free-form metadata object. Example: {"team": "support"}
    orderstring
    Sort order. One of: asc, desc. Example: descone of ascdesc
    takeinteger
    Number of items to return. Example: 25
  • chatbotkit_bot_getGet one bot with its model, backstory, dataset and skillset.Read-only

    Get Bot

    Get one bot with its model, backstory, dataset and skillset. Returns an object with alias, name, description, meta, id, createdAt, updatedAt, model, backstory, datasetId, and more. Use chatbotkit_bot_get for one bot.

    Inputs

    bot_idstringrequired
    Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
  • chatbotkit_bot_usage_getGet token and conversation usage of a bot.Read-only

    Get Bot Usage

    Get token and conversation usage of a bot. Returns an object with tokens, conversations, messages. Use chatbotkit_bot_usage_get for one bot. Use chatbotkit_usage_get for the account.

    Inputs

    bot_idstringrequired
    Bot ID from chatbotkit_bots_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    fromstring
    Start date for the period (ISO 8601 format) Example: 2026-01-31T12:00:00Z
    tostring
    End date for the period (ISO 8601 format) Example: 2026-01-31T12:00:00Z
  • chatbotkit_bots_listList the bots in the account.Read-only

    List Bots

    List the bots in the account. Returns items[] (each with alias, name, description, meta, id, createdAt, updatedAt, model) plus cursor. Use chatbotkit_bots_list to find a bot ID. Use chatbotkit_bot_get for one bot.

    Inputs

    contact_idstring
    Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    cursorstring
    Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    metastring
    Free-form metadata object. Example: {"team": "support"}
    orderstring
    Sort order. One of: asc, desc. Example: descone of ascdesc
    takeinteger
    Number of items to return. Example: 25
  • chatbotkit_contact_conversations_listList the conversations of a contact.Read-only

    List Contact Conversations

    List the conversations of a contact. Returns items[] (each with name, description, meta, id, createdAt, updatedAt, botId, contactId) plus cursor. Use chatbotkit_contact_conversations_list to see a user history.

    Inputs

    contact_idstringrequired
    Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    cursorstring
    Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    orderstring
    Sort order. One of: asc, desc. Example: descone of ascdesc
    takeinteger
    Number of items to return. Example: 25
  • chatbotkit_contact_getGet one contact.Read-only

    Get Contact

    Get one contact. Returns an object with name, description, meta, id, createdAt, updatedAt, fingerprint, email, phone, nick, and more. Use chatbotkit_contact_get for one contact.

    Inputs

    contact_idstringrequired
    Contact ID from chatbotkit_contacts_list. Example: cm1a2b3c4d5e6f7g8h9i0j1k
  • chatbotkit_contacts_listList contacts (end users who talk to your bots).Read-only

    List Contacts

    List contacts (end users who talk to your bots). Returns items[] (each with name, description, meta, id, createdAt, updatedAt, fingerprint, email) plus cursor. Use chatbotkit_contacts_list to find a contact ID.

    Inputs

    cursorstring
    Pagination cursor: the id of the last item from the previous page. Example: cm1a2b3c4d5e6f7g8h9i0j1k
    metastring
    Free-form metadata object. Example: {"team": "support"}
    orderstring
    Sort order. One of: asc, desc. Example: descone of ascdesc
    takeinteger
    Number of items to return. Example: 25