30 秒内完成你的第一次调用
没有 SDK 的繁文缛节：带上你的密钥发一次 HTTPS 调用就够了。
$ 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 /usageWebhook 管理
创建并管理 Webhook 端点、发送测试 ping 并查看送达历史——全程通过 API 完成。
CRUD /webhooksPOST /webhooks/{id}/testGET /webhooks/{id}/deliveries诚实的限额，明明白白写在包装上
| 套餐 | 每日调用次数 | 速率限制 | API 访问 |
|---|---|---|---|
| Free | 100 | 60/min | 垃圾检测 |
| Basic | 1 000 | 60/min | 垃圾检测 |
| Pro | 10 000 | 600/min | 完整 API + Webhook |
| Business | 50 000 | 1 800/min | 完整 API + Webhook |
限额按账户计算，而非按密钥。每个响应都携带 X-Quota-Limit、X-Quota-Used 和 X-Quota-Reset 响应头，触及上限时会返回一个干净的 429，并附带 Retry-After——绝无意外。
本该如此打造的密钥
只显示一次，以哈希存储
完整密钥只在创建那一刻出现一次。Telm 只存储哈希——包括我们在内，没有人能把你的密钥读回来。
读/写作用域
密钥带有读和写的作用域。给你的报表脚本一个只读密钥——它在物理上就无法更改任何设置。
即时吊销
在仪表盘吊销任意密钥，它便立即失效。一个账户级的一键开关可以一次冻结全部 API 访问。
同一个引擎，如今由你掌控
公开 API 暴露的正是驱动 Telm 机器人的那一套审核引擎——不是简化版的仿制品。向 /spam/check POST 一段文本，它就会经过与你群组所用完全相同的流水线：声誉信号、规则，以及可选的 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.