Spam Detection API API Reference

Easily and directly scan and block spam security threats in input.

Swagger OpenAPI Specification | .NET Framework Client | .NET Core Client | Java Client | Node.JS Client | Python Client | Drupal Client

Version: v1

Authentication

Apikey

Apikey

type
apiKey
name
Apikey
in
header

Paths

SpamDetection

Perform AI spam detection and classification against input text string. Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content. Uses 25-75 API calls depending on model selected.

POST /spam/detect/text-string


SpamDetectionRequest

Spam detection request

Code Example:
Request Content-Types: application/json, text/json, application/*+json
Request Example
{
  "InputString": "Get free crypto now!!!",
  "Model": "Advanced"
}
200 OK
SpamDetectionResponse

OK

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK) 
{
  "CleanResult": "boolean"
}
SpamDetection

Perform advanced AI spam detection and classification against input text string. Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content. Uses 25-100 API calls depending on model selected.

POST /spam/detect/text-string/advanced


SpamDetectionAdvancedRequest

Spam detection request

Code Example:
Request Content-Types: application/json, text/json, application/*+json
Request Example
{
  "InputString": "string",
  "Model": "string",
  "AllowUnsolicitedSales": "boolean",
  "AllowPromotionalContent": "boolean",
  "AllowPhishing": "boolean"
}
200 OK
SpamDetectionAdvancedResponse

OK

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK) 
{
  "CleanResult": "boolean",
  "ContainsSpam": "boolean",
  "ContainsUnsolicitedSales": "boolean",
  "ContainsPromotionalContent": "boolean",
  "ContainsPhishingAttempt": "boolean"
}

Schema Definitions

SpamDetectionAdvancedRequest: object

AI advanced spam detection request

InputString: string

Input text string to detect spam against

Model: string

Optional: Specify which AI model to use. Possible choices are Normal and Advanced. Default is Advanced.

AllowUnsolicitedSales: boolean

True if unsolicited sales should be allowed, false otherwise

AllowPromotionalContent: boolean

True if promotional content should be allowed, false otherwise

AllowPhishing: boolean

True if phishing should be allowed, false otherwise

Example
{
  "InputString": "string",
  "Model": "string",
  "AllowUnsolicitedSales": "boolean",
  "AllowPromotionalContent": "boolean",
  "AllowPhishing": "boolean"
}

SpamDetectionAdvancedResponse: object

Result of detecting spam using AI

CleanResult: boolean

True if the result is not spam (clean), and false otherwise

ContainsSpam: boolean

True if the input text contains spam, false otherwise

ContainsUnsolicitedSales: boolean

True if the input text contains unsolicited sales, false otherwise

ContainsPromotionalContent: boolean

True if the input text contains promotional content, false otherwise

ContainsPhishingAttempt: boolean

True if the input text contains a phishing attempt, false otherwise

Example
{
  "CleanResult": "boolean",
  "ContainsSpam": "boolean",
  "ContainsUnsolicitedSales": "boolean",
  "ContainsPromotionalContent": "boolean",
  "ContainsPhishingAttempt": "boolean"
}

SpamDetectionRequest: object

AI spam detection request

InputString: string

Input text string to detect spam against

Model: string

Optional: Specify which AI model to use. Possible choices are Normal and Advanced. Default is Advanced.

Example
{
  "InputString": "Get free crypto now!!!",
  "Model": "Advanced"
}

SpamDetectionResponse: object

Result of detecting spam using AI

CleanResult: boolean

True if the result is not spam (clean), and false otherwise

Example
{
  "CleanResult": "boolean"
}