Moderation power,
callable from your code
Wire Telm into your own systems: check any text with the production anti-spam engine, manage group settings and rules from code, read the decision journal and analytics — all through a clean REST API with keys you control.
- Stable REST v1
- Spam check on every plan
- Webhooks included
Your first call in 30 seconds
No SDK ceremony: an HTTPS call with your key is all it takes.
$ curl -X POST https://api.telm.com/api/public/v1/spam/check \
-H "Authorization: Bearer tk_live_..." \
-d '{"text": "Earn $500/day from home!! DM me now"}'
// HTTP 200
{
"verdict": "spam",
"score": 97,
"reasons": ["contact_flow", "money_lure"]
}One request, one verdict from the production engine — with a score and the reasons that fired. The response arrives in well under a second for rule-based checks.
What the API can do
Spam & user checks
Run any text through the same engine that protects Telm groups — single calls, batches up to 20, and user screening against CAS plus Telm's own dataset.
POST /spam/checkPOST /spam/check-batchPOST /users/checkGroups & settings
Read and patch protection settings, manage custom moderation rules and the whitelist — for one group or a fleet of them.
GET/PATCH /groups/{id}/settingsCRUD /groups/{id}/rulesCRUD /groups/{id}/whitelistJournal & analytics
Read every engine decision with verdict, score and triggered rules, pull daily analytics series, and track your own quota usage.
GET /groups/{id}/journalGET /groups/{id}/analyticsGET /usageWebhooks management
Create and manage webhook endpoints, send test pings and inspect the delivery history — entirely through the API.
CRUD /webhooksPOST /webhooks/{id}/testGET /webhooks/{id}/deliveriesHonest limits, printed on the box
| Plan | Calls per day | Rate limit | API access |
|---|---|---|---|
| Free | 100 | 60/min | Spam check |
| Basic | 1 000 | 60/min | Spam check |
| Pro | 10 000 | 600/min | Full API + webhooks |
| Business | 50 000 | 1 800/min | Full API + webhooks |
Limits apply per account, not per key. Every response carries X-Quota-Limit, X-Quota-Used and X-Quota-Reset headers, and hitting a limit returns a clean 429 with Retry-After — no surprises.
Keys built like they should be
Shown once, stored hashed
The full key appears exactly once, at creation. Telm stores only a hash — nobody, including us, can read your key back.
Read/write scopes
Keys carry read and write scopes. Give your reporting script a read-only key — it physically cannot change any settings.
Instant revocation
Revoke any key from the dashboard and it stops working immediately. A per-account kill switch can freeze all API access at once.
The full API and webhooks are included in Pro and Business. Spam checking is available on every plan — including Free — within the daily quota.
The same engine, now under your control
The public API exposes the same moderation engine that runs Telm's bot — not a simplified imitation. POST a text to /spam/check and it passes through the identical pipeline your groups use: reputation signals, rules, and optionally the AI classifier. That means you can embed Telm's judgement anywhere: a support form, your own bot, a comment section, an internal tool.
Beyond checks, the API manages your groups as code. Read and patch protection settings, create moderation rules, maintain whitelists — the same operations as the dashboard, but scriptable. Agencies running dozens of communities can roll out a policy change with one loop instead of dozens of clicks.
History is first-class: the journal endpoint returns every decision the engine made — verdict, score, which rules fired, what action was taken — with cursor pagination built for archiving. Combined with the analytics endpoint you can build compliance archives, internal dashboards or alerting on top of your group's real data.
Authentication is deliberately boring: bearer keys created in your dashboard, shown once, stored hashed, with read/write scopes and instant revocation. Every response carries quota headers so your integration always knows where it stands.
Frequently asked questions
Which plans include API access?
Spam checking (/spam/check) works on every plan, including Free, within the daily quota. The full API — group settings, rules, journal, analytics, user screening and webhooks — is included in Pro and Business.
What are the request limits?
Daily quotas by plan: Free 100, Basic 1,000, Pro 10,000, Business 50,000 calls. Rate limits: 60 requests per minute on Free and Basic, 600 on Pro, 1,800 on Business. Every response includes X-Quota-Limit, X-Quota-Used and X-Quota-Reset headers.
How do I get an API key?
In the dashboard under Settings → API & Webhooks. The key is shown once at creation — only its hash is stored. You can hold up to 10 active keys, scope them to read-only, and revoke any of them instantly.
Can the AI classifier be used through the API?
AI checks consume the plan’s separate daily AI quota: Basic 100, Pro 1,000, Business 10,000 (Free has none).
Is there an OpenAPI specification?
Yes, the full machine-readable OpenAPI 3.1 spec is published alongside the developer documentation, so you can generate clients or plug it into your tooling.
Related features
Explore more ways Telm can help your community