Overview
Spam Detector works by analyzing the text provided and detecting if it is spam. It uses advanced algorithms to analyze the text and return the likelihood of spam.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl -X POST https://api.apiverve.com/v1/spamdetector \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"text": "Can you please spare some change?! Desperate!!! Send cash",
"email": "bankers@fre.323hotlain.net",
"ip": "122.180.184.182"
}'const res = await fetch('https://api.apiverve.com/v1/spamdetector', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"text": "Can you please spare some change?! Desperate!!! Send cash",
"email": "bankers@fre.323hotlain.net",
"ip": "122.180.184.182"
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/spamdetector",
headers={"x-api-key": "your_api_key_here"},
json={
"text": "Can you please spare some change?! Desperate!!! Send cash",
"email": "bankers@fre.323hotlain.net",
"ip": "122.180.184.182"
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"text": "Can you please spare some change?! Desperate!!! Send cash",
"email": "bankers@fre.323hotlain.net",
"ip": "122.180.184.182"
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/spamdetector", body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
textRequired | string | The text to detect spam in |
emailOptional | string | The email address to validate against the spam database. This is optional email |
ipOptionalPremium | string | The IP address to validate against the spam database. This is optional ip |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"likelySpam": true,
"isDisposableEmail": false,
"isIPBlacklisted": false,
"ipDetails": {
"country": "IN",
"region": "DL"
},
"parsed": true
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
likelySpam | boolean | true | Indicates whether the text is likely spam |
isDisposableEmailPremium | boolean | false | Indicates if email address uses disposable email service |
isIPBlacklistedPremium | boolean | false | Indicates if IP address is on malicious blocklist |
ipDetails | object | {...} | |
countryPremium | string | "IN" | Country code where IP address is geographically located |
regionPremium | string | "DL" | Region or state where IP address is located |
parsed | boolean | true | Indicates whether input data was successfully parsed |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Content Moderation
- Use the Spam Detector API to detect spam in content. Use the data to filter out spam, protect users, and maintain quality
- Email Validation
- Detect spam by using the Spam Detector API to validate email addresses. Use the data to verify emails, prevent fraud, and protect against spam
- Text Analysis
- Use the Spam Detector API to analyze text for spam. Use the data to identify spam, filter out unwanted content, and maintain security
Other ways to use Spam Detector
Set up Spam Detector on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Data Validation: