About

The Spam Detection API checks if the provided content passes a spam filtration test and provides a percentage confidence score along with an explanation for whether it is considered spam or not.
This API is ideal for developers working on content moderation tools, email filtering, and social media platforms. It automates the spam detection process, helping to maintain the quality and integrity of user-generated content. Use cases include moderating forum posts, filtering spam emails, and analyzing user comments for spammy content.
Select API Endpoints
Input(s)

API Playground

API Documentation

Detect Spam Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/content/detect_spam

Request example

1
```cURL
2
3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/content/detect_spam' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
"content": "Hello, this is John from Finance Plus. I'\''ve called before, We'\''ve helped other individuals like you improve their credit. Please give me a call later."
8
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProvide the content to check whether it is spam.
Sample Response
1
{
2
"status_url": "https://api.apyhub.com/sharpapi/api/v1/content/detect_spam/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
"job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles