Skip to content

KeywordFilterKeyword

A word of a keyword filter.

object
keyword
required

The word or phrase, as the user typed it. It matches the text, the content warning, the poll’s choices, and the alt text of a post, each on its own, regardless of case, of half-width and full-width forms, and of katakana and hiragana; runs of white space match one space. Up to 100 characters once normalized.

string
>= 1 characters <= 400 characters
whole_word
required

Whether the word matches only where no letter, digit, or _ touches it. Characters of scripts that do not separate words with spaces (Chinese, Japanese, Thai, and the like) never count as touching, so there the word matches anywhere.

boolean

Example generated

{
"keyword": "example",
"whole_word": true
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site