Moderation API

A hosted text filter: send a piece of text, get back whether it is clean, which listed words or patterns it contains, a masked copy, and a severity tier. It is the same word-list and regex engine that moderates Calihan's own products, offered on its own with an API key.

REST + JSON API key auth 100,000 calls / month $99 / month

Buy Moderation API in the Atlas store — $99/month

Billing runs through Atlas (Atlas IP Holdings LLC), which is the account that owns your subscription. Already subscribed? Open your Atlas account to get or rotate your key.

1. What it does

Every call scans your text against two term lists merged together: the shared global list that ships with the service, and your own list, which only your key can see and edit. Terms are whole words, multi-word phrases, or regular expressions. Matching is word-boundary based, so "class" or "document" are not flagged for the words inside them, and the curated regex stems catch common misspellings and stretched spellings.

Each term carries an action and a tier:

TierDefault actionWhat it means
mild, medium, strongmaskOrdinary profanity, in rising severity. The text comes back with each match replaced by [profanity].
slurmaskSlurs. Masked, and reported at the slur severity so you can route it for review.
safetyblockThreats, self-harm language, sexual solicitation, drugs, payment-scam phrases, doxxing. The result is action: "block"; you decide whether to hold or reject the text.

A block match wins over a mask match. A result is one of clean, mask or block, with the highest tier found and the list of hits (term, tier, weight, action and the exact text matched).

Conduct scoring. Inside Calihan's own products the same engine keeps a 0–100 conduct score per user and can shadowban repeat offenders. The standalone API does not do this: it scores each piece of text on its own and keeps no per-user history for you. If you want a per-user score, build it from the severity and hits you get back.

2. Getting a key (self-serve)

  1. Create or sign in to an Atlas account and confirm your email address.
  2. Buy Moderation API — Standard ($99/month) in the Atlas store. Payment is taken by Stripe.
  3. On your Atlas account page, choose Get / manage your API key. Atlas signs you in to the key page, which checks your subscription and mints your key.
  4. Copy the key straight away. It is shown once; only a hash is stored. If you lose it, come back the same way and rotate: you get a new key and the old one stops working.

One active key per Atlas account. If the subscription is cancelled or refunded, the key is switched off.

3. Quickstart

# put your key in an environment variable (it starts with mod_)
export MODERATION_KEY="paste-your-key-here"

curl -X POST https://app.dossierdating.com/api/v1/moderation/scan \
  -H "Content-Type: application/json" \
  -H "X-Moderation-Key: $MODERATION_KEY" \
  -d '{"text": "this is some damn text"}'

Response:

{
  "ok": true,
  "action": "mask",
  "flagged": true,
  "masked": "this is some [profanity] text",
  "severity": "mild",
  "hits": [{"term": "damn\\w*", "tier": "mild", "weight": 1.0, "action": "mask", "match": "damn"}]
}

4. Endpoints

Base URL https://app.dossierdating.com. Every request sends the key in the X-Moderation-Key header.

MethodPathPurpose
POST/api/v1/moderation/scanScan {"text": "..."}. Counts as one call against your quota.
GET/api/v1/moderation/termsList the terms on your own list.
POST/api/v1/moderation/termsAdd a term: {"term", "kind": word|phrase|regex, "action": mask|block, "tier": mild|medium|strong|slur|safety}.
DELETE/api/v1/moderation/terms/{id}Remove one of your terms.
GET/api/v1/moderation/usageCalls used this calendar month, your quota and what remains.

Edits to your list take effect without a redeploy, typically within a minute.

5. Quota and errors

The Standard plan includes 100,000 scan calls per calendar month. Only /scan is metered. When the month's quota is used up, /scan answers 429 with quota_exceeded until the next month; there is no automatic overage billing.

6. Limitations

7. Price

$99 per month, billed by Atlas through Stripe, including 100,000 scan calls a month. Cancel from your Atlas account; the key stops working when the subscription ends.

Buy Moderation API in the Atlas store

Also from Calihan: the Calihan Trust API.