BotStar logoDocsCommunityEngine APILivechat API

How to use Public API swagger?

Step 1: Go to app.botstar.com/account/profile to get the API token, API Token > copy the Token.
Step 2: Go back to apis.botstar.com/docs, Authorize button > paste the API token to the Value Input > Close button.
Step 3: Click the First Endpoint > Try it out > Execute: you will see the result.
Your browser does not support the video tag.
Simple Video Tutorial

How to find bot ID, user ID?

Bot ID
Option 1: Use /bots endpoint to get all bots, each bot will contain bot ID.
Option 2: Login to app.botstar.com > Bot Builder > copy the bot ID segment
User ID
Login to app.botstar.com > Report & Insight > Audience > click on a chat user The User ID is displayed under the information on the left of the screen.

How to find CMS Entity ID, Entity Item ID?

CMS Entity ID
Steps: Login to app.botstar.com > CMS > click a CMS Entity > copy the Entity ID segment

CMS Entity Item ID
Steps: Login to app.botstar.com > CMS > click a CMS Entity > click a CMS Entity Item > copy the ID segment

How to find CMS Entity ID, Entity Item ID?

CMS Entity ID
Steps: Login to app.botstar.com > CMS > click a CMS Entity > copy the Entity ID segment

CMS Entity Item ID
Steps: Login to app.botstar.com > CMS > click a CMS Entity > click a CMS Entity Item > copy the ID segment

How to find Bot Language Configuration?

Bot Language Configuration
Steps: Login to app.botstar.com > click to Settings