API Documentation
Integrate spam and phishing detection into your application.
Quick Start
1. Get your API key from your dashboard
2. Make a POST request to the classify endpoint with your content
3. Receive classification results in JSON format
Authentication
All API requests require an API key in the X-API-Key header:
X-API-Key: your_api_key_here
Endpoints
POST
/api/v1/classifyAnalyze content for spam, phishing, or scam indicators.
Request Body
{
"content": "The text content to analyze",
"type": "email", // optional: "email", "text", "url"
"metadata": { // optional
"sender": "sender@example.com",
"subject": "Email subject line"
}
}Response
{
"classification": "Spam", // "Legitimate", "Spam", "Phishing", "Scam"
"isSpam": true, // true if not Legitimate
"confidence": 0.95, // 0.0 to 1.0
"reasons": [
"Contains suspicious patterns"
],
"recommendations": [
"Do not click any links"
],
"usage": {
"used": 42,
"limit": 100,
"remaining": 58
}
}GET
/api/v1/usageCheck your current API usage.
Response
{
"tier": "free",
"usage": {
"used": 42,
"limit": 100,
"remaining": 58
},
"rateLimit": {
"perMinute": 10
}
}Error Codes
| Code | Error | Description |
|---|---|---|
| 401 | Missing API key | No X-API-Key header provided |
| 401 | Invalid API key | API key not recognized |
| 429 | Limit exceeded | Usage limit reached - contact to upgrade |
| 400 | Missing content | No content field in request body |
Rate Limits
Free Tier: 100 total requests • 10 requests/minute
Need more capacity? Contact us to discuss custom plans.
Ready to Get Started?
Get your API key and start protecting your users today.