Przejdź do treści głównej
Publiczne REST API

Moc moderacji,
wywoływalna z Twojego kodu

Wepnij Telm we własne systemy: sprawdzaj dowolny tekst produkcyjnym silnikiem antyspamowym, zarządzaj ustawieniami i regułami grup z poziomu kodu, odczytuj dziennik decyzji i analitykę — wszystko przez czyste REST API z kluczami, które kontrolujesz.

  • Stabilne REST v1
  • Sprawdzanie spamu w każdym planie
  • Webhooki w komplecie
$Twój kodtk_live_…Twój klucz APISilnik TelmTwoja grupa

Twoje pierwsze wywołanie w 30 sekund

Bez ceregieli z SDK: wystarczy wywołanie HTTPS z Twoim kluczem.

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

Jedno żądanie, jeden werdykt z produkcyjnego silnika — z oceną i powodami, które się uruchomiły. Odpowiedź przychodzi grubo poniżej sekundy dla sprawdzeń opartych na regułach.

Co potrafi API

Sprawdzanie spamu i użytkowników

Przepuść dowolny tekst przez ten sam silnik, który chroni grupy Telm — pojedyncze wywołania, paczki do 20 pozycji oraz weryfikacja użytkowników wobec CAS i własnego zbioru danych Telm.

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

Grupy i ustawienia

Odczytuj i modyfikuj ustawienia ochrony, zarządzaj własnymi regułami moderacji i białą listą — dla jednej grupy lub całej ich floty.

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

Dziennik i analityka

Odczytuj każdą decyzję silnika wraz z werdyktem, oceną i uruchomionymi regułami, pobieraj dzienne serie analityczne i śledź własne zużycie limitu.

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

Zarządzanie webhookami

Twórz endpointy webhooków i zarządzaj nimi, wysyłaj testowe pingi i przeglądaj historię dostarczeń — w całości przez API.

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

Uczciwe limity, wypisane wprost na opakowaniu

PlanWywołań dziennieLimit tempaDostęp do API
Free10060/minSprawdzanie spamu
Basic1 00060/minSprawdzanie spamu
Pro10 000600/minPełne API + webhooki
Business50 0001 800/minPełne API + webhooki

Limity obowiązują na konto, a nie na klucz. Każda odpowiedź niesie nagłówki X-Quota-Limit, X-Quota-Used i X-Quota-Reset, a przekroczenie limitu zwraca czyste 429 z Retry-After — żadnych niespodzianek.

Klucze zbudowane tak, jak być powinny

Pokazany raz, przechowywany jako hash

Pełny klucz pojawia się dokładnie raz, przy tworzeniu. Telm przechowuje tylko hash — nikt, łącznie z nami, nie odczyta Twojego klucza z powrotem.

Zakresy odczyt/zapis

Klucze niosą zakresy odczytu i zapisu. Daj swojemu skryptowi raportującemu klucz tylko do odczytu — fizycznie nie zdoła zmienić żadnych ustawień.

Natychmiastowe unieważnianie

Unieważnij dowolny klucz w panelu, a przestanie działać natychmiast. Wyłącznik awaryjny na poziomie konta potrafi zamrozić cały dostęp do API naraz.

Pełne API w Pro i Business

Pełne API i webhooki są wliczone w plany Pro i Business. Sprawdzanie spamu jest dostępne w każdym planie — także we Free — w ramach dziennego limitu.

Ten sam silnik, teraz pod Twoją kontrolą

Publiczne API udostępnia dokładnie ten sam silnik moderacji, który napędza bota Telm — a nie jego uproszczoną imitację. Wyślij tekst metodą POST na /spam/check, a przejdzie on przez identyczny potok, z którego korzystają Twoje grupy: sygnały reputacyjne, reguły i opcjonalnie klasyfikator AI. Dzięki temu ocenę Telm możesz wpleść wszędzie: w formularz wsparcia, we własnego bota, w sekcję komentarzy czy narzędzie wewnętrzne.

Poza sprawdzaniem API zarządza Twoimi grupami jak kodem. Odczytuj i modyfikuj ustawienia ochrony, twórz reguły moderacji, utrzymuj białe listy — te same operacje co w panelu, ale skryptowalne. Agencje prowadzące dziesiątki społeczności mogą wdrożyć zmianę polityki jedną pętlą zamiast dziesiątkami kliknięć.

Historia to obywatel pierwszej kategorii: endpoint dziennika zwraca każdą decyzję silnika — werdykt, ocenę, które reguły się uruchomiły i jakie działanie podjęto — z paginacją kursorową stworzoną z myślą o archiwizacji. W połączeniu z endpointem analityki możesz budować archiwa zgodności, wewnętrzne pulpity czy alerty na podstawie rzeczywistych danych Twojej grupy.

Uwierzytelnianie jest celowo nudne: klucze bearer tworzone w panelu, pokazywane raz, przechowywane jako hash, z zakresami odczyt/zapis i natychmiastowym unieważnianiem. Każda odpowiedź niesie nagłówki limitów, więc Twoja integracja zawsze wie, na czym stoi.

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.

Gotowy, aby zacząć?

Zacznij chronić swoją społeczność już dziś. Dostępny plan darmowy.