最初の呼び出しは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"]
}1リクエストで、本番エンジンから1つの判定を——スコアと、発火した理由とともに。ルールベースのチェックなら、レスポンスは1秒を大きく下回って届きます。
APIでできること
スパムとユーザーのチェック
Telmのグループを守るのと同じエンジンに任意のテキストを通せます——単発の呼び出し、最大20件のバッチ、そしてCASおよびTelm独自のデータセットに対するユーザースクリーニング。
POST /spam/checkPOST /spam/check-batchPOST /users/checkグループと設定
保護設定の読み取りと更新、カスタムモデレーションルールとホワイトリストの管理を——1つのグループでも、多数のグループ群でも行えます。
GET/PATCH /groups/{id}/settingsCRUD /groups/{id}/rulesCRUD /groups/{id}/whitelistジャーナルと分析
エンジンの各判定を、判定結果・スコア・発火したルールとともに読み取り、日次の分析データ系列を取得し、自分のクォータ使用量を追跡できます。
GET /groups/{id}/journalGET /groups/{id}/analyticsGET /usageウェブフックの管理
ウェブフックのエンドポイントを作成・管理し、テストpingを送信し、配信履歴を確認できます——すべてAPI経由で。
CRUD /webhooksPOST /webhooks/{id}/testGET /webhooks/{id}/deliveries箱に刷り込まれた、正直な上限
| プラン | 1日あたりの呼び出し | レート制限 | APIアクセス |
|---|---|---|---|
| Free | 100 | 60/min | スパムチェック |
| Basic | 1 000 | 60/min | スパムチェック |
| Pro | 10 000 | 600/min | フルAPI＋ウェブフック |
| Business | 50 000 | 1 800/min | フルAPI＋ウェブフック |
上限はキー単位ではなくアカウント単位で適用されます。すべてのレスポンスに X-Quota-Limit、X-Quota-Used、X-Quota-Reset ヘッダーが載り、上限に達すると Retry-After 付きのクリーンな429が返ります——不意打ちはありません。
あるべき姿で作られたキー
表示は一度、保存はハッシュ
完全なキーが表示されるのは作成時のちょうど一度だけ。Telmが保存するのはハッシュのみで、私たちを含め誰もあなたのキーを読み戻せません。
read/write のスコープ
キーはreadとwriteのスコープを持ちます。レポート用スクリプトにはread-onlyキーを渡せば、物理的にどの設定も変更できません。
即時失効
ダッシュボードから任意のキーを失効させれば、直ちに使えなくなります。アカウント単位のキルスイッチで、すべてのAPIアクセスを一度に凍結することも可能です。
同じエンジンを、いまあなたの手の内に
公開APIは、Telmのボットを動かしているのと同じモデレーションエンジンをそのまま公開します——簡略化した模造品ではありません。/spam/check にテキストをPOSTすると、あなたのグループが使っているのと同一のパイプラインを通ります——レピュテーションのシグナル、ルール、そしてオプションでAI分類器。つまりTelmの判断をどこにでも組み込めるということです——サポートフォーム、自作のボット、コメント欄、社内ツールに。
チェックにとどまらず、APIはあなたのグループをコードとして管理します。保護設定の読み取りと更新、モデレーションルールの作成、ホワイトリストの保守——ダッシュボードと同じ操作を、スクリプト化して行えます。数十のコミュニティを運営する代理店なら、数十回のクリックではなく1つのループでポリシー変更を展開できます。
履歴も一級市民です。ジャーナルのエンドポイントは、エンジンが下したすべての判定——判定結果、スコア、発火したルール、実行されたアクション——を、アーカイブ向けに設計されたカーソルページネーションとともに返します。分析エンドポイントと組み合わせれば、グループの実データの上にコンプライアンス用アーカイブ、社内ダッシュボード、アラートを構築できます。
認証はあえて退屈に作ってあります。ダッシュボードで作成するbearerキーは、一度だけ表示され、ハッシュ化して保存され、read/write のスコープと即時失効を備えます。すべてのレスポンスにクォータ用ヘッダーが載るので、連携先は自分の状況をつねに把握できます。
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.