Skip to content

Add bot protection docs for assistant #5264

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Open

Add bot protection docs for assistant #5264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions ai/assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,21 @@
<img src="/images/assistant/search-suggestions-dark.png" alt="The search suggestions panel in the dashboard with contextual starter questions enabled." className="hidden dark:block" />
</Frame>

### Bot protection

In the Bot Protection section, enable invisible captcha to protect your assistant from automated abuse. The captcha uses [hCaptcha](https://www.hcaptcha.com/privacy), which is privacy-friendly and invisible to nearly all visitors.

To enable bot protection:

1. Go to the [Assistant settings](https://dashboard.mintlify.com/products/assistant/settings) page in your dashboard.
2. In the **Bot Protection** section, toggle **Invisible Captcha** on.

Changes take up to 10 minutes to propagate.

<Note>
If you use custom [Content Security Policy headers](/deploy/csp-configuration), make sure `hcaptcha.com` and `*.hcaptcha.com` are included in your allowlist.

Check warning on line 116 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L116 

In general, use active voice instead of passive voice ('are included').
</Note>

## Customize assistant behavior

Add a `.mintlify/Assistant.md` file at the root of your documentation project to give the assistant custom instructions that shape how it responds (`Assistant.md` is also an accepted filename). The assistant uses these instructions as system-level context for every response.
Expand Down
Loading