Tools (4)

check_text
censor_text
get_word_count
report_feedback

check_text

Check text for profanity.

Returns whether the text contains profanity, a list of flagged words,
the total word count, and the number of distinct flagged words.

Parameter	Type	Required	Description
`text`	`string`	required	Text to check for profanity.

Request Body

{
  "text": "example"
}

censor_text

Censor profanity in text by replacing flagged words with a replacement string.

Returns the censored text, original length, and the number of words censored.

Parameter	Type	Required	Description
`text`	`string`	required	Text to censor.
`replacement`	`string`	optional	Replacement string for profane words. (default: "***")

Request Body

{
  "text": "example"
}

get_word_count

Get the number of words in the profanity dictionary.

Returns the size of the built-in profanity word list used for filtering.

Request Body

{
  "query": "example"
}

report_feedback

Report a bug, feature request, or general feedback for this data source.

Use this when something doesn't work as expected, when you'd like
a new feature, or when you have suggestions for improvement.

Args:
feedback: Describe the issue or suggestion.
feedback_type: One of 'bug', 'feature_request', or 'general'.

Parameter	Type	Required	Description
`feedback`	`string`	required
`feedback_type`	`string`	optional	(default: "general")

Request Body

{
  "feedback": "example"
}

Quick Start

Shell

curl -X POST "https://context.gnist.ai/rest/profanity-filter/check_text" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"text": "example"}'

Python

import httpx

resp = httpx.post(
    "https://context.gnist.ai/rest/profanity-filter/check_text",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    json={
  "text": "example"
},
)
print(resp.json())