Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to BotStar

Scalekit connector
Open markdown

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

Tools
25
What they doRead · write · destructive
8 · 13 · 48 read13 write4 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 BotStar connection

    In AgentKit > Connections, create a BotStar 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 = 'botstar'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize BotStar:', 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: 'botstar_bots_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their BotStar 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
  • botstar_bot_attributes_listList a bot's attributes (bot-wide variables such as business hours or a phone number).Read-only

    List Bot Attributes

    List a bot's attributes (bot-wide variables such as business hours or a phone number). Returns each attribute's ID, name, data type, value and per-language values. Use botstar_bot_attributes_list to read bot variables.

    Inputs

    bot_idstringrequired
    Bot ID, from botstar_bots_list or the Bot Builder URL. Example: s5d8f1c2a-3b4e-4f6a-9c1d-2e7f8a9b0c1d
    envstring
    Which version to read: draft or live. One of: draft, live. Example: liveone of draftlive
  • botstar_bot_getGet one bot by ID.Read-only

    Get Bot

    Get one bot by ID. Returns the bot's name, languages, channels and settings. Use botstar_bot_get to check a bot's configuration.

    Inputs

    bot_idstringrequired
    Bot ID, from botstar_bots_list or the Bot Builder URL. Example: s5d8f1c2a-3b4e-4f6a-9c1d-2e7f8a9b0c1d
  • botstar_bots_listList the bots in your BotStar account.Read-only

    List Bots

    List the bots in your BotStar account. Returns each bot's ID, name and settings. Use botstar_bots_list to find a bot_id for the other tools.

    Inputs

    This tool takes no inputs.

  • botstar_cms_entities_listList a bot's CMS entities (content tables such as products or FAQs).Read-only

    List CMS Entities

    List a bot's CMS entities (content tables such as products or FAQs). Returns each entity's ID, name and fields. Use botstar_cms_entities_list to find an entity_id. Use botstar_cms_items_list for its rows.

    Inputs

    bot_idstringrequired
    Bot ID, from botstar_bots_list or the Bot Builder URL. Example: s5d8f1c2a-3b4e-4f6a-9c1d-2e7f8a9b0c1d
    envstring
    Which version to read: draft or live. One of: draft, live. Example: liveone of draftlive
  • botstar_cms_entity_getGet one CMS entity with its fields.Read-only

    Get CMS Entity

    Get one CMS entity with its fields. Returns the entity's name and field definitions. Use botstar_cms_entity_get to see which fields an item can have.

    Inputs

    bot_idstringrequired
    Bot ID, from botstar_bots_list or the Bot Builder URL. Example: s5d8f1c2a-3b4e-4f6a-9c1d-2e7f8a9b0c1d
    entity_idstringrequired
    CMS entity ID, from botstar_cms_entities_list. Example: e8a1b2c3d4e5f6a7b8c9d0e1f
    envstring
    Which version to read: draft or live. One of: draft, live. Example: liveone of draftlive
  • botstar_cms_item_getGet one CMS item.Read-only

    Get CMS Item

    Get one CMS item. Returns the item's name, status and field values. Use botstar_cms_item_get when you know the item ID.

    Inputs

    bot_idstringrequired
    Bot ID, from botstar_bots_list or the Bot Builder URL. Example: s5d8f1c2a-3b4e-4f6a-9c1d-2e7f8a9b0c1d
    entity_idstringrequired
    CMS entity ID, from botstar_cms_entities_list. Example: e8a1b2c3d4e5f6a7b8c9d0e1f
    item_idstringrequired
    CMS entity item ID, from botstar_cms_items_list. Example: i1a2b3c4d5e6f7a8b9c0d1e2f
    envstring
    Which version to read: draft or live. One of: draft, live. Example: liveone of draftlive
  • botstar_cms_items_listList the items (rows) of a CMS entity, optionally by name or status.Read-only

    List CMS Items

    List the items (rows) of a CMS entity, optionally by name or status. Returns a page of items with their field values. Use botstar_cms_items_list to read content. Use botstar_cms_item_get for one item.

    Inputs

    bot_idstringrequired
    Bot ID, from botstar_bots_list or the Bot Builder URL. Example: s5d8f1c2a-3b4e-4f6a-9c1d-2e7f8a9b0c1d
    entity_idstringrequired
    CMS entity ID, from botstar_cms_entities_list. Example: e8a1b2c3d4e5f6a7b8c9d0e1f
    envstring
    Which version to read: draft or live. One of: draft, live. Example: liveone of draftlive
    limitinteger
    Items per page (default 100). Example: 50
    namestring
    Only items with this name. Example: Blue T-shirt
    pageinteger
    Page number, starting at 1. Example: 1
    statusstring
    enabled or disabled. One of: enabled, disabled. Example: enabledone of enableddisabled
  • botstar_user_getGet a chat user of a bot with their attributes.Read-only

    Get User

    Get a chat user of a bot with their attributes. Returns the user's profile and user attributes (standard and custom). Use botstar_user_get to read what the bot knows about a user.

    Inputs

    bot_idstringrequired
    Bot ID, from botstar_bots_list or the Bot Builder URL. Example: s5d8f1c2a-3b4e-4f6a-9c1d-2e7f8a9b0c1d
    user_idstringrequired
    Chat user ID (shown under Report & Insight > Audience in BotStar). Example: 2849192718472910