Profanity Check lets you send text and get back a profanity analysis for that content. Use it when you need to screen user-generated text before publishing it in a comment, chat message, review, or profile field.
Send a text string, and optionally set language with a 2- to 5-character code. The endpoint is designed for simple moderation workflows where you want to detect offensive language without building your own word lists or rules engine.
Use Profanity Check in sign-up forms, community platforms, moderation queues, or content pipelines where unfiltered text could create trust or safety issues. It fits into pre-submit validation as well as post-submit review.
The response returns a structured result for the text check. Because the output schema is open-ended, treat the returned fields as the service's profanity analysis payload and inspect the response directly in your integration.
Check a piece of text for profanity by sending it with the required text field.
curl -X POST "https://api.eu.apyhub.com/dosvak/profanity-check" \
-H "apy-token: $APY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"text":"This is a clean example sentence.","language":"en"}'Returns a JSON object. The schema does not declare any specific top-level fields, so the exact response shape may vary.
{
"language": "en",
"contains_profanity": true,
"match_count": 2,
"matches": [
"word_1",
"word_2"
],
"attribution": [
{
"source": "censor-text/profanity-list"
}
]
}Loading your default key…Checks a submitted text string for profanity and returns a response object. The exact response shape is not defined in the output schema, so the endpoint’s success payload should be treated as an object with additional properties.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| text | String | Yes | Text to check. Minimum length 1. |
| language | String | No | Language code for the text. Minimum length 2, maximum length 5. Default: en. |
bad_requestRequired parameter missing or malformed body.
unauthorizedAPI key missing, revoked, or not authorized for this service.
rate_limitedYour plan's per-second rate exceeded. Retry with exponential backoff.
upstream_busyBackend temporarily unavailable. Try again in a few seconds.