Hoppa till huvudinnehåll
Publikt REST API

Modereringskraft,
anropbar från din kod

Koppla in Telm i dina egna system: kontrollera vilken text som helst med produktionens antispam-motor, hantera gruppinställningar och regler från kod, läs beslutsloggen och analysen — allt via ett rent REST API med nycklar du kontrollerar.

  • Stabil REST v1
  • Spamkontroll i alla planer
  • Webhooks ingår
$Din kodtk_live_…Din API-nyckelTelm-motornDin grupp

Ditt första anrop på 30 sekunder

Inget SDK-krångel: ett HTTPS-anrop med din nyckel är allt som krävs.

spam-check.sh
$ 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"]
}

En förfrågan, ett utlåtande från produktionsmotorn — med en poäng och skälen som utlöstes. Svaret kommer på klart under en sekund för regelbaserade kontroller.

Vad API:et kan göra

Spam- & användarkontroller

Kör vilken text som helst genom samma motor som skyddar Telm-grupper — enskilda anrop, batchar upp till 20 och användarkontroll mot CAS plus Telms eget dataset.

POST /spam/checkPOST /spam/check-batchPOST /users/check

Grupper & inställningar

Läs och patcha skyddsinställningar, hantera egna modereringsregler och vitlistan — för en grupp eller en hel flotta.

GET/PATCH /groups/{id}/settingsCRUD /groups/{id}/rulesCRUD /groups/{id}/whitelist

Logg & analys

Läs varje motorbeslut med utlåtande, poäng och utlösta regler, hämta dagliga analysserier och håll koll på din egen kvotförbrukning.

GET /groups/{id}/journalGET /groups/{id}/analyticsGET /usage

Webhooks-hantering

Skapa och hantera webhook-endpoints, skicka test-pingar och granska leveranshistoriken — helt via API:et.

CRUD /webhooksPOST /webhooks/{id}/testGET /webhooks/{id}/deliveries

Ärliga gränser, tryckta på förpackningen

PlanAnrop per dagHastighetsgränsAPI-åtkomst
Free10060/minSpamkontroll
Basic1 00060/minSpamkontroll
Pro10 000600/minHela API:et + webhooks
Business50 0001 800/minHela API:et + webhooks

Gränserna gäller per konto, inte per nyckel. Varje svar bär headerna X-Quota-Limit, X-Quota-Used och X-Quota-Reset, och när en gräns nås returneras en ren 429 med Retry-After — inga överraskningar.

Nycklar byggda som de borde vara

Visas en gång, lagras hashad

Den fullständiga nyckeln visas exakt en gång, vid skapandet. Telm lagrar bara en hash — ingen, inte ens vi, kan läsa tillbaka din nyckel.

Läs-/skrivbehörigheter

Nycklar bär läs- och skrivbehörigheter. Ge ditt rapporteringsskript en skrivskyddad nyckel — den kan fysiskt inte ändra någon inställning.

Omedelbar återkallelse

Återkalla vilken nyckel som helst från panelen så slutar den fungera omedelbart. En kill switch per konto kan frysa all API-åtkomst på en gång.

Hela API:et i Pro och Business

Hela API:et och webhooks ingår i Pro och Business. Spamkontroll är tillgänglig i alla planer — inklusive Free — inom den dagliga kvoten.

Samma motor, nu under din kontroll

Det publika API:et exponerar samma modereringsmotor som driver Telms bot — ingen förenklad imitation. Skicka en text med POST till /spam/check och den går genom exakt samma pipeline som dina grupper använder: ryktessignaler, regler och valfritt AI-klassificeraren. Det betyder att du kan bädda in Telms omdöme var som helst: ett supportformulär, din egen bot, ett kommentarsfält, ett internt verktyg.

Utöver kontroller hanterar API:et dina grupper som kod. Läs och patcha skyddsinställningar, skapa modereringsregler, underhåll vitlistor — samma operationer som i panelen, men skriptbara. Byråer som driver dussintals communityn kan rulla ut en policyändring med en enda loop i stället för dussintals klick.

Historiken är förstklassig: logg-endpointen returnerar varje beslut motorn fattade — utlåtande, poäng, vilka regler som utlöstes, vilken åtgärd som vidtogs — med markörpaginering byggd för arkivering. Tillsammans med analys-endpointen kan du bygga efterlevnadsarkiv, interna paneler eller aviseringar ovanpå din grupps verkliga data.

Autentiseringen är medvetet tråkig: bearer-nycklar som du skapar i panelen, visas en gång, lagras hashade, med läs-/skrivbehörigheter och omedelbar återkallelse. Varje svar bär kvot-headers så att din integration alltid vet var den står.

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.

Redo att börja?

Börja skydda din gemenskap idag. Gratis plan tillgänglig.