profanity-check
Returns a masked copy, severity-tagged segments, per-category counts and an overall verdict. The slur dictionary itself is never exposed, and the submitted text is not stored or logged.
v1 beta server · 1 tokens
Call it
POST https://timbrica.com/v1/tools/profanity-check/runs
Authorization: Bearer $TIMBRICA_KEY
Idempotency-Key: <your retry-safe key>
Content-Type: application/jsonInput
| Field | Type | Required | Notes |
|---|---|---|---|
text | string | yes |
Text to analyse.
max length: 50000 |
strictness | string | no |
slurs = only slurs; standard = slurs + profanity; all = includes euphemisms.
one of: slurs, standard, all default: standard |
mode | string | no |
How matches are masked in the returned copy.
one of: dot, star, remove, first default: dot |
scope | string | no | one of: text, name default: text |
categories | array | no | Restrict detection to these categories. Omit for all. |
Errors it can return
empty_text
text_too_long
processing_failed
History
- v1 — 2026-07-30 — Initial release.
This contract cannot change without a new version and a line above: a test compares the published schema, pricing and limits against a committed lockfile and fails the build otherwise. Subscribe to /v1/changelog to be told when something moves.
