API Key

To use our service an API Key is needed to authenticate and authorize your bot.
Your API Key is your_api_key.

SDK

Install SDK

BotPotter provides developers an SDK to develop and deploy their bots.

npm install @botpotter/sdk

dotnet add package <PACKAGE_NAME>

python3 -m pip install @botpotter/sdk

Initialize Client

The BotPotter client needs to be initialized to interact with the BotPotter API.

import { client as BotPotter } from “@botpotter”
const botPotter = new BotPotter(your_api_key)

dotnet add package <PACKAGE_NAME>

import @botpotter
botPotter = new BotPotter(your_api_key)

Deploy Bot

Once you are satisfied with your bot it can be deployed to our infrastructure.

npx botpotter deploy

python deploy.py

Bot

Create Bot

A bot is added when using the following method.

botPotter.createBot({ name: “”, options: { ... } })

Update Bot

A bot is updated when using the following method.

botPotter.updateBot({ ... })

Remove Bot

A bot is removed when using the following method.

botPotter.removeBot()

Dialog Flows

Add Dialog Flows

A dialog flow is added when using the following method.

botPotter.addDialogFlow({ name: “”, options: { ... } })

Update Dialog Flow

A dialog flow is updated when using the following method.

botPotter.updateDialogFlow()

Remove Dialog Flow

A dialog flow is removed when using the following method.

botPotter.removeDialogFlow()

Screens

Add Dialog Flows

A screen is added when using the following method.

botPotter.addScreen({ name: “”, options: { ... } })

Update Screen

A screen is updated when using the following method.

botPotter.updateScreen()

Remove Screen

A screen is removed when using the following method.

botPotter.removeScreen()