Skip to content

docs: add AI to quickstart #1389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 8, 2025
Merged

docs: add AI to quickstart #1389

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d93266
add ai reference to quickstart
haleychaas Oct 8, 2025
c9960bd
pr feedback
haleychaas Oct 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/english/building-an-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,8 +475,8 @@ Now that you have a basic app up and running, you can start exploring how to mak

* Read through the concepts pages to learn about the different methods and features your Bolt app has access to.

* Explore the different events your bot can listen to with the [`app.event()`](/tools/bolt-python/concepts/event-listening) method. All of the events are listed [on the API docs site](/reference/events).
* Explore the different events your bot can listen to with the [`app.event()`](/tools/bolt-python/concepts/event-listening) method. View the full events reference docs [here](/reference/events).

* Bolt allows you to [call Web API methods](/tools/bolt-python/concepts/web-api) with the client attached to your app. There are [over 200 methods](/reference/methods) on our API site.
* Bolt allows you to [call Web API methods](/tools/bolt-python/concepts/web-api) with the client attached to your app. There are over 200 methods; view them [here](/reference/methods).

* Learn more about the different token types [on the API docs site](/authentication/tokens). Your app may need different tokens depending on the actions you want it to perform.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👾 praise: This is so nice to direct link to!

* Learn more about the different token types in the [tokens guide](/authentication/tokens). Your app may need different tokens depending on the actions you want it to perform.
35 changes: 35 additions & 0 deletions docs/english/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,41 @@ This will open the following page:

On these pages you're free to make changes such as updating your app icon, configuring app features, and perhaps even distributing your app!

## Add AI features {#ai-features}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Add AI features {#ai-features}
## Adding AI features {#ai-features}

🔮 suggestion: Mirroring a change suggested in adjacent PR!


Now that you're familiar with a basic app setup, try it out again, this time using the AI agent template!

<Tabs groupId="cli-or-terminal">
<TabItem value="cli" label="Slack CLI">

Get started with the agent template:

```sh
$ slack create ai-app --template slack-samples/bolt-python-assistant-template
$ cd ai-app
```

</TabItem>
<TabItem value="terminaL" label="Terminal">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<TabItem value="terminaL" label="Terminal">
<TabItem value="terminal" label="Terminal">

📺 suggestion: I too encourage using the CLI perhaps more but remain case sensitive!


Get started with the agent template:

```sh
$ git clone https://github.com/slack-samples/bolt-python-assistant-template ai-app
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 note: Similar to slackapi/bolt-js#2676 this path might change soon!

$ cd ai-app
```

Using this method, be sure to set the app and bot tokens as we did in the [Running the app](#running-the-app) section above.

</TabItem>
</Tabs>

Once the project is created, update the `.env.sample` file by setting the `OPENAI_API_KEY` with the value of your key and removing the `.sample` from the file name.

In the `ai` folder of this app, you'll find default instructions for the LLM and an OpenAI client setup.

The `listeners` include utilities intended for messaging with an LLM. Those are outlined in detail in the guide to [Using AI in apps](/tools/bolt-python/concepts/ai-apps) and [Sending messages](/tools/bolt-python/concepts/message-sending).

## Next steps {#next-steps}

Congrats once more on getting up and running with this quick start.
Expand Down
Loading