Перейти до основного вмісту
Публічний REST API

Сила модерації,
викликана з вашого коду

Підключіть Telm до власних систем: перевіряйте будь-який текст бойовим антиспам-движком, керуйте налаштуваннями груп і правилами з коду, читайте журнал рішень та аналітику — усе через чистий REST API з ключами, якими володієте ви.

  • Стабільний REST v1
  • Перевірка спаму на кожному плані
  • Webhooks у комплекті
$Ваш кодtk_live_…Ваш API-ключДвижок TelmВаша група

Ваш перший виклик за 30 секунд

Жодних церемоній із SDK: достатньо HTTPS-виклику з вашим ключем.

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

Один запит — один вердикт від бойового движка, з оцінкою та причинами, що спрацювали. Для перевірок за правилами відповідь приходить значно менш ніж за секунду.

Що вміє API

Перевірка спаму та користувачів

Пропускайте будь-який текст через той самий движок, що захищає групи Telm, — поодинокі виклики, пакети до 20 і перевірка користувачів за CAS та власним датасетом Telm.

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

Групи та налаштування

Читайте й змінюйте налаштування захисту, керуйте власними правилами модерації та білим списком — для однієї групи чи цілого їх флоту.

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

Журнал та аналітика

Читайте кожне рішення движка — з вердиктом, оцінкою та спрацьованими правилами, витягуйте щоденні аналітичні ряди й відстежуйте власне використання квоти.

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

Керування webhooks

Створюйте вебхук-ендпоінти й керуйте ними, надсилайте тестові пінги та переглядайте історію доставки — повністю через API.

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

Чесні ліміти, надруковані на коробці

ПланВикликів на деньRate limitДоступ до API
Free10060/minПеревірка спаму
Basic1 00060/minПеревірка спаму
Pro10 000600/minПовний API + webhooks
Business50 0001 800/minПовний API + webhooks

Ліміти діють на акаунт, а не на ключ. Кожна відповідь несе заголовки X-Quota-Limit, X-Quota-Used та X-Quota-Reset, а досягнення ліміту повертає чистий 429 із Retry-After — без сюрпризів.

Ключі, зроблені як належить

Показано раз, збережено хешем

Повний ключ з'являється рівно один раз, під час створення. Telm зберігає лише хеш — ніхто, зокрема ми, не зможе прочитати ваш ключ назад.

Скоупи читання/запису

Ключі несуть скоупи читання й запису. Дайте своєму звітному скрипту ключ read-only — він фізично не зможе змінити жодне налаштування.

Миттєве відкликання

Відкличте будь-який ключ у кабінеті — і він одразу перестає працювати. Загальний kill switch на акаунт може заморозити весь доступ до API за раз.

Повний API на Pro та Business

Повний API та webhooks входять до Pro та Business. Перевірка спаму доступна на кожному плані — зокрема Free — у межах щоденної квоти.

Той самий движок — тепер під вашим контролем

Публічний API відкриває той самий движок модерації, що працює в боті Telm, — не спрощену імітацію. Надішліть текст POST-запитом на /spam/check, і він пройде через ідентичний конвеєр, яким користуються ваші групи: репутаційні сигнали, правила та, за потреби, AI-класифікатор. Це означає, що судження Telm можна вбудувати будь-куди: у форму підтримки, власного бота, секцію коментарів чи внутрішній інструмент.

Окрім перевірок, API керує вашими групами як кодом. Читайте й змінюйте налаштування захисту, створюйте правила модерації, ведіть білі списки — ті самі операції, що й у кабінеті, але скриптовані. Агенції, які ведуть десятки спільнот, можуть розкотити зміну політики одним циклом замість десятків кліків.

Історія — повноцінна частина: ендпоінт журналу повертає кожне рішення движка — вердикт, оцінку, які правила спрацювали, яку дію застосовано — з курсорною пагінацією, створеною для архівування. У парі з ендпоінтом аналітики ви побудуєте архіви для комплаєнсу, внутрішні дашборди чи алерти поверх реальних даних вашої групи.

Автентифікація навмисно нудна: bearer-ключі, створені у вашому кабінеті, показані один раз, збережені у вигляді хешу, зі скоупами читання/запису та миттєвим відкликанням. Кожна відповідь несе заголовки квоти, тож ваша інтеграція завжди знає, де вона стоїть.

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.

Готові почати?

Почніть захищати свою спільноту сьогодні. Безкоштовний план доступний.