> For the complete documentation index, see [llms.txt](https://docs.kickbot.com/dashboard/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kickbot.com/dashboard/api/reference/moderation.md).

# Moderation

KickBot API and MCP reference for Moderation. Chat filters: links, caps, banned words, regex, message length.

Chat filters: links, caps, banned words, regex, message length. MCP area name: `moderation`.

| Tool                                                        | REST                         | Access |
| ----------------------------------------------------------- | ---------------------------- | ------ |
| [`get_moderation_settings`](#get-moderation-settings)       | `GET /moderation/settings`   | Read   |
| [`update_moderation_settings`](#update-moderation-settings) | `PATCH /moderation/settings` | Write  |
| [`list_moderation_logs`](#list-moderation-logs)             | `GET /moderation/logs`       | Read   |

## get\_moderation\_settings

**Get the chat moderation settings.** Read the chat filters KickBot uses to delete messages: bad words, repeated text, caps, zalgo, message length, banned words, and banned regex.

`GET /api/v1/moderation/settings`

No input fields.

## update\_moderation\_settings

**Update the chat moderation settings.** Change some chat filters. Only the fields you send change; lists replace the whole list. Requires a verified account. Returns the saved settings (check the lists: invalid entries are dropped).

`PATCH /api/v1/moderation/settings`

Needs a read and write key or connection.

| Field                   | Type            | Required | Description                                                                                                                                                                                                                 |
| ----------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bad_word_filter`       | boolean         | No       | Delete messages that contain words from KickBot's built-in bad word list.                                                                                                                                                   |
| `repeated_text_filter`  | boolean         | No       | Delete messages with a lot of repeated text (spam).                                                                                                                                                                         |
| `excessive_caps_filter` | boolean         | No       | Delete messages that are mostly capital letters.                                                                                                                                                                            |
| `zalgo_filter`          | boolean         | No       | Delete messages with zalgo (glitch) text.                                                                                                                                                                                   |
| `max_message_length`    | integer         | No       | Delete messages longer than this many characters. 500 (the default) means no length limit. Must be at least 1.                                                                                                              |
| `custom_banned_words`   | array of string | No       | Your own banned words or phrases. Replaces the whole list. Entries shorter than 2 characters are dropped; at most 200 are kept. A newline-separated string also works.                                                      |
| `banned_regex`          | array of string | No       | Regular expressions (JavaScript syntax) that delete matching messages. Replaces the whole list. Invalid patterns and patterns with nested quantifiers like (a+)+ are dropped; at most 20 are kept. Check the returned list. |

## list\_moderation\_logs

**List moderation logs.** List the chat messages the filters deleted, newest first: who sent it, the reason (the filter), and the message.

`GET /api/v1/moderation/logs`

| Field            | Type    | Required | Description                             |
| ---------------- | ------- | -------- | --------------------------------------- |
| `limit` (query)  | integer | No       | Max logs to return (1-100, default 50). |
| `offset` (query) | integer | No       | Number of logs to skip (default 0).     |

## Need help?

Email <support@kickbot.com> or ask in the `#support` channel on [Discord](https://discord.gg/MAg3gBbc89).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.kickbot.com/dashboard/api/reference/moderation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
