Přejít na hlavní obsah
Veřejné REST API

Síla moderace,
volatelná z vašeho kódu

Zapojte Telm do vlastních systémů: prověřte libovolný text produkčním antispamovým enginem, spravujte nastavení a pravidla skupin z kódu, čtěte deník rozhodnutí i analytiku — to vše přes čisté REST API s klíči, které řídíte vy.

  • Stabilní REST v1
  • Kontrola spamu v každém plánu
  • Webhooky v ceně
$Váš kódtk_live_…Váš API klíčEngine TelmVaše skupina

Vaše první volání za 30 sekund

Žádné SDK ceremonie: stačí HTTPS volání s vaším klíčem.

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"]
}

Jeden požadavek, jeden verdikt z produkčního enginu — se skóre a důvody, které se spustily. U kontrol založených na pravidlech dorazí odpověď výrazně pod jednu sekundu.

Co API umí

Kontroly spamu a uživatelů

Prožeňte libovolný text stejným enginem, který chrání skupiny Telm — jednotlivá volání, dávky až po 20 a prověrku uživatelů proti CAS i vlastnímu datasetu Telm.

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

Skupiny a nastavení

Čtěte a upravujte nastavení ochrany, spravujte vlastní pravidla moderace i whitelist — pro jednu skupinu nebo celou flotilu.

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

Deník a analytika

Čtěte každé rozhodnutí enginu s verdiktem, skóre a spuštěnými pravidly, stahujte denní analytické řady a sledujte vlastní spotřebu kvóty.

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

Správa webhooků

Vytvářejte a spravujte webhookové endpointy, posílejte testovací pingy a prohlížejte historii doručení — celé přes API.

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

Poctivé limity, vytištěné na krabici

PlánVolání za denRate limitPřístup k API
Free10060/minKontrola spamu
Basic1 00060/minKontrola spamu
Pro10 000600/minPlné API + webhooky
Business50 0001 800/minPlné API + webhooky

Limity platí na účet, ne na klíč. Každá odpověď nese hlavičky X-Quota-Limit, X-Quota-Used a X-Quota-Reset a při dosažení limitu vrátí čistou 429 s Retry-After — žádná překvapení.

Klíče postavené tak, jak mají být

Zobrazeno jednou, uloženo jako hash

Plný klíč se objeví přesně jednou, při vytvoření. Telm ukládá pouze hash — nikdo, včetně nás, váš klíč nepřečte zpět.

Rozsahy čtení/zápis

Klíče nesou rozsahy čtení a zápis. Dejte svému reportovacímu skriptu klíč jen pro čtení — fyzicky nemůže změnit žádné nastavení.

Okamžité odvolání

Odvolejte kterýkoli klíč z dashboardu a okamžitě přestane fungovat. Nouzový vypínač pro celý účet umí naráz zmrazit veškerý přístup k API.

Plné API v plánech Pro a Business

Plné API a webhooky jsou součástí plánů Pro a Business. Kontrola spamu je dostupná v každém plánu — včetně Free — v rámci denní kvóty.

Tentýž engine, teď pod vaší kontrolou

Veřejné API zpřístupňuje tentýž moderační engine, který pohání bota Telm — ne zjednodušenou napodobeninu. Pošlete POST s textem na /spam/check a projde identickým procesem jako vaše skupiny: signály reputace, pravidla a volitelně AI klasifikátor. Znamená to, že úsudek Telm můžete zabudovat kamkoli: do podpůrného formuláře, vlastního bota, sekce komentářů nebo interního nástroje.

Kromě kontrol API spravuje vaše skupiny jako kód. Čtěte a upravujte nastavení ochrany, vytvářejte pravidla moderace, udržujte whitelisty — stejné operace jako v dashboardu, ale skriptovatelné. Agentury spravující desítky komunit tak zavedou změnu politiky jedním cyklem místo desítek kliknutí.

Historie je prvořadá: endpoint deníku vrací každé rozhodnutí, které engine učinil — verdikt, skóre, která pravidla se spustila i jakou akci provedl — s kurzorovým stránkováním připraveným k archivaci. Ve spojení s analytickým endpointem tak nad reálnými daty své skupiny postavíte archivy pro compliance, interní dashboardy nebo alerting.

Autentizace je záměrně nudná: bearer klíče vytvořené ve vašem dashboardu, zobrazené jen jednou, uložené jako hash, s rozsahy čtení/zápis a okamžitým odvoláním. Každá odpověď nese hlavičky kvóty, takže vaše integrace vždy ví, na čem je.

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.

Připraveni začít?

Začněte chránit svou komunitu ještě dnes. K dispozici je bezplatný plán.