Botstar

Tool to create a new bot in BotStar. Use when you need to create a new bot instance with a specific name.

Untrusted display-only summary

Tool to create a new bot attribute in BotStar. Bot attributes are global variables for a bot and support multilingual values. Use when you need to define custom data fields for your bot.

Untrusted display-only summary

Tool to create a CMS entity in BotStar with a name and optional fields. Use when you need to define a new content structure with custom fields supporting various data types.

Untrusted display-only summary

Tool to create entity field(s) in BotStar CMS. Supports multiple field types including text, multiple_values, single_option, multiple_options, image, date, and entity. Use when you need to add new fields to an existing entity.

Untrusted display-only summary

Tool to create a new entity item in BotStar CMS. Use when adding items to a CMS entity with custom field values.

Untrusted display-only summary

Tool to create custom user attributes in BotStar. Use when you need to define new custom attributes for users with specified field name and type.

Untrusted display-only summary

Tool to delete a bot attribute by ID. Use when you need to remove a custom attribute from a bot.

Untrusted display-only summary

Tool to delete a CMS entity by ID. Use when you need to remove an entity from the bot's content management system.

Untrusted display-only summary

Tool to delete entity field(s) from a CMS entity. Use when you need to remove fields from a CMS entity by their unique names.

Untrusted display-only summary

Tool to delete an entity item from a CMS entity. Use when you need to remove a specific item from a bot's CMS entity.

Untrusted display-only summary

Tool to get your bot by bot ID. Use when you need detailed bot information including ID, name, and team name.

Untrusted display-only summary

Tool to retrieve the BotStar application ID (`appId`). Use when initializing or reinitializing the live chat widget.

Untrusted display-only summary

Tool to get a specific CMS entity by ID. Returns entity details including fields configuration. Use when you need to retrieve metadata about a CMS entity structure.

Untrusted display-only summary

Tool to retrieve a specific item from a CMS entity with all field values. Use when you need to get detailed information about a single entity item.

Untrusted display-only summary

Tool to get all bot attributes from BotStar. Returns array of bot attributes with id, name, desc, value, and data_type. Use when you need to retrieve or inspect all attributes configured for a bot.

Untrusted display-only summary

Tool to get your list of bots. Use when you need to retrieve all bots associated with your account. Returns an array of bots with their id, name, and team_name.

Untrusted display-only summary

Tool to retrieve all CMS entities for a bot. Use when you need to access entity definitions, field configurations, or available entity schemas.

Untrusted display-only summary

Tool to retrieve all entity items with pagination support. Use when you need to list CMS entity items, with optional filtering by name and status.

Untrusted display-only summary

Tool to reinitialize the live chat widget with provided data. Use after initial load to reset or update widget configuration.

Untrusted display-only summary

Tool to hide the live chat window. Use when the chat widget is configured in livechat or popup mode.

Untrusted display-only summary

Tool to register a callback when the chat window is closed. Use after the widget is initialized. Example prompt: "Register an onClose handler that logs 'Goodbye!' to the console."

Untrusted display-only summary

Tool to register a callback when the chat window is opened. Use after widget initialization.

Untrusted display-only summary

Tool to show the live chat window. Use after the widget has been bootstrapped with BotStarApi('boot') to programmatically open the chat window (mode must be 'livechat' or 'popup').

Untrusted display-only summary

Tool to update user details on the current live chat session. Use when you need to modify user profile attributes during an active conversation.

Untrusted display-only summary

Tool to publish a bot to live. Use when you need to deploy changes to the production environment.

Untrusted display-only summary

Tool to update a bot attribute in BotStar. Use when you need to modify the description or value of a bot attribute with optional multilingual support.

Untrusted display-only summary

Tool to update a CMS entity in BotStar. Use when you need to modify the name or configuration of an existing CMS entity.

Untrusted display-only summary

Tool to update entity field(s) in BotStar CMS. Use when you need to modify the name or options of existing fields.

Untrusted display-only summary

Tool to update a CMS entity item in BotStar. Use when you need to modify the name, status, or custom field values of an entity item.

Untrusted display-only summary

Tool to retrieve a parameter value passed from the BotStar chatbot to the webview. Use inside onChatBotReady after your page loads in modal mode with bs:input meta tags.

Untrusted display-only summary