<aside> 🔨 This documentation is under construction, so there are many missing components. If you need something that is missing here, please contact us.

</aside>

Installation

Installing the RunLLM Slackbot is simple. Follow these steps:

  1. Navigate to https://api.runllm.com/slack/install, and authorize the RunLLM Slackbot to have access to the target workspace.

  2. Navigate to the RunLLM admin UI and find your API key in the bottom right corner. Copy your API key.

    image.png

  3. On the RunLLM admin UI, note down the ID of your assistant. You will find this in the URL, which will be of the form: [https://app.runllm.com/assistant/<ID>](https://app.runllm.com/assistant/<id>)

  4. In your Slack workspace, run /set-runllm <api-key> <assistant-id>.

  5. Add the RunLLM Slackbot to the desired channel and tag it (@RunLLM). The bot will respond to any questions asked in a thread.

Additional Configuration: Respond to every message

By default, RunLLM will respond to messages only when tagged. However, you also have the option to have the assistant respond to all messages in a channel. Follow these steps:

  1. In the target channel, run the command /set-runllm-channel <api-key>. You will see a configuration pane that looks like this:

    image.png

  2. The first field can be left as the default, assuming you’re only using one assistant for your workspace. Please contact us if you plan to use multiple.

  3. The second field can be toggled between “Respond only to mentions” or “Respond to all in channel” — select the second option to have the assistant respond in a thread to every message sent in the channel.