KeywordFilter
A keyword filter of the user, which only the user sees. The server matches the posts it returns against the filters of their contexts, so every client gets the same result; the user’s own posts and boosts are never matched.
object
The ID of a resource, a UUIDv7 in its canonical string form.
The name of the filter, 1 to 50 characters, which a folded post shows.
What a keyword filter does to a post that matches it: warn returns the post with the filter
in its filtered, and clients fold it behind the filter’s title; hide leaves the post out,
as if the user could not see it.
Where the filter applies, at least one.
The words of the filter, in the order given; a post matches the filter when it matches any of them.
A word of a keyword filter.
object
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.
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.
When the filter stops applying; omitted for a filter that never does. An expired filter stays, applying nowhere, and applies again when its expiry moves later.
Whether the filter has expired and applies nowhere.
When the user created the filter.
Example generated
{ "id": "01890a5d-ac96-774b-bcce-b302099a8057", "title": "example", "action": "warn", "contexts": [ "home" ], "keywords": [ { "keyword": "example", "whole_word": true } ], "expires_at": "2026-04-15T12:00:00Z", "expired": true, "created_at": "2026-04-15T12:00:00Z"}For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt