Crisp

BoostGPT Crisp is a streamlined and user-friendly SDK that enables you to set up your own AI Crisp bot in a flash.

Features

• Can only reply to messages when all operators are offline

• Can engage in a conversation.

Requirements

• Node v10 and above

• CRISP_PLUGIN_IDENTIFIER:

This is a unique identifier that is associated with your Crisp plugin. The identifier will be listed under the plugin you have created. To get your identifier, go to the Crisp marketplace and create a plugin. Find out how here: https://docs.crisp.chat/guides/rest-api/authentication/

• CRISP_PLUGIN_KEY:

This is an authentication key that is used to authorize access to your Crisp plugin. To get create your key, go to the Crisp marketplace and create a plugin. Find out how here: https://docs.crisp.chat/guides/rest-api/authentication/

• OPENAI_API_KEY:

You need to have an OpenAI account and API key. Go to the OpenAI developer portal, create an account, and generate an API key.

• BOOSTGPT_API_KEY:

You need to have a BoostGPT account and API key. Go to the BoostGPT site, create an account, and generate an API key.

• BOOSTGPT_PROJECT_ID:

You need to create a project on BoostGPT to use its API. After creating a project, you can get its project ID from the dashboard.

• BOOSTGPT_BOT_ID:

You will need to have created a BoostGPT bot and have its ID. To get your bot's ID, go to your bot's settings page on the BoostGPT dashboard and copy the bot ID.

Installation

git clone [e-mail]:boostgpt/boostgpt-crisp.git

Run npm install

Configuration

To create a .env file with the above requirements, you can follow these steps:

1. Rename the file .env.exclude to .env.

2. Open the .env file in a text editor.

3. Edit the following lines in the file, replacing the placeholders with the actual tokens and IDs:

    CRISP_PLUGIN_IDENTIFIER=your_crisp_plugin_identifier_here
    CRISP_PLUGIN_KEY=your_crisp_plugin_key_here
    OPENAI_API_KEY=your_openai_api_key_here
    BOOSTGPT_API_KEY=your_boostgpt_api_key_here
    BOOSTGPT_PROJECT_ID=your_boostgpt_project_id_here
    BOOSTGPT_BOT_ID=your_boostgpt_bot_id_here

1. Save the file

Make sure to keep the .env file secure and not share it publicly, as it contains sensitive information that could be used to access your bots and APIs.

Start your bot

Run node index.js to start your bot.

We recommend using the pm2 process manager to start your bot in production mode.

To do this you have to:

• Install pm2 globally using the command npm install -g pm2.

• Navigate to the directory where your index.js file is located.

• Start your bot by running the command pm2 start index.js --name my-bot where my-bot is the name of your bot.

• Pm2 will automatically detect the Node.js runtime and launch the application in cluster mode.

• Verify that your bot is running by checking its status with the command pm2 status.

• If you need to stop the bot, you can run the command pm2 stop my-bot.

• If you need to restart the bot, you can run the command pm2 restart my-bot.

Using pm2 provides a number of benefits, including process management, automatic restarts in case of crashes, and monitoring capabilities.

Questions?

Join our Discord server.