Spam Detection API API Reference

Version: v1

Authentication

Apikey

type

apiKey

name

Apikey

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

Response Content-Types: text/plain, application/json, text/json

Response Example (200 OK)

{
  "CleanResult": "boolean"
}

SpamDetection

Perform AI spam detection and classification on an input image or document (PDF or DOCX). Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content. Uses 100-125 API calls depending on model selected.

POST /spam/detect/file

model: string Advanced

in header

Model to use; default setting is Advanced

inputFile: file

in formData

(no description)

Code Example:

200 OK

SpamDetectionResponse

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": "Buy bitcoin now!!!!",
  "Model": "Advanced",
  "AllowUnsolicitedSales": false,
  "AllowPromotionalContent": false,
  "AllowPhishing": false
}

200 OK

SpamDetectionAdvancedResponse

Response Content-Types: text/plain, application/json, text/json

Response Example (200 OK)

{
  "CleanResult": "boolean",
  "SpamRiskLevel": "number (double)",
  "ContainsSpam": "boolean",
  "ContainsUnsolicitedSales": "boolean",
  "ContainsPromotionalContent": "boolean",
  "ContainsPhishingAttempt": "boolean",
  "AnalysisRationale": "string"
}

SpamDetection

Perform advanced AI spam detection and classification against a form submission. Analyzes form 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/form-submission/advanced

SpamDetectionAdvancedFormSubmissionRequest

Spam detection request

Code Example:

Request Content-Types: application/json, text/json, application/*+json

Request Example

{
  "InputFormFields": [
    {
      "FieldTitle": "LeadCompanyName",
      "FieldValue": "Acme, Inc."
    }
  ],
  "AllowUnsolicitedSales": false,
  "AllowPromotionalContent": false,
  "AllowPhishing": false
}

200 OK

SpamDetectionFormSubmissionAdvancedResponse

Response Content-Types: text/plain, application/json, text/json

Response Example (200 OK)

{
  "CleanResult": "boolean",
  "SpamRiskLevel": "number (double)",
  "ContainsSpam": "boolean",
  "ContainsUnsolicitedSales": "boolean",
  "ContainsPromotionalContent": "boolean",
  "ContainsPhishingAttempt": "boolean",
  "AnalysisRationale": "string"
}

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/file/advanced

model: string Advanced

in header

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

preprocessing: string Auto

in header

Optional: Specify which preprocessing to Use. Possible choices are None, Compatability and Auto. Default is Auto.

allowPhishing: boolean false

in header

True if phishing should be allowed, false otherwise

allowUnsolicitedSales: boolean false

in header

True if unsolicited sales should be allowed, false otherwise

allowPromotionalContent: boolean true

in header

True if promotional content should be allowed, false otherwise

inputFile: file

in formData

(no description)

Code Example:

200 OK

SpamDetectionAdvancedResponse

Response Content-Types: text/plain, application/json, text/json

Response Example (200 OK)

{
  "CleanResult": "boolean",
  "SpamRiskLevel": "number (double)",
  "ContainsSpam": "boolean",
  "ContainsUnsolicitedSales": "boolean",
  "ContainsPromotionalContent": "boolean",
  "ContainsPhishingAttempt": "boolean",
  "AnalysisRationale": "string"
}

Schema Definitions

SpamDetectionAdvancedFormField: object

Form field submitted to run spam detection on

FieldTitle: string: Title of the field
FieldValue: string: Value of the field

Example

{
  "FieldTitle": "LeadCompanyName",
  "FieldValue": "Acme, Inc."
}

SpamDetectionAdvancedFormSubmissionRequest: object

AI advanced spam detection request

InputFormFields: SpamDetectionAdvancedFormField: Form fields and values that you received in your form submission
SpamDetectionAdvancedFormField
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

{
  "InputFormFields": [
    {
      "FieldTitle": "LeadCompanyName",
      "FieldValue": "Acme, Inc."
    }
  ],
  "AllowUnsolicitedSales": false,
  "AllowPromotionalContent": false,
  "AllowPhishing": false
}

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": "Buy bitcoin now!!!!",
  "Model": "Advanced",
  "AllowUnsolicitedSales": false,
  "AllowPromotionalContent": false,
  "AllowPhishing": false
}

SpamDetectionAdvancedResponse: object

Result of detecting spam using AI

CleanResult: boolean: True if the result is not spam (clean), and false otherwise
SpamRiskLevel: number (double): Overall spam risk level between 0.0 and 1.0
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
AnalysisRationale: string: Rationale for why the conclusion was formed

Example

{
  "CleanResult": "boolean",
  "SpamRiskLevel": "number (double)",
  "ContainsSpam": "boolean",
  "ContainsUnsolicitedSales": "boolean",
  "ContainsPromotionalContent": "boolean",
  "ContainsPhishingAttempt": "boolean",
  "AnalysisRationale": "string"
}

SpamDetectionFormSubmissionAdvancedResponse: object

Result of detecting spam using AI

CleanResult: boolean: True if the result is not spam (clean), and false otherwise
SpamRiskLevel: number (double): Overall spam risk level between 0.0 and 1.0
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
AnalysisRationale: string: Rationale for why the conclusion was formed

Example

{
  "CleanResult": "boolean",
  "SpamRiskLevel": "number (double)",
  "ContainsSpam": "boolean",
  "ContainsUnsolicitedSales": "boolean",
  "ContainsPromotionalContent": "boolean",
  "ContainsPhishingAttempt": "boolean",
  "AnalysisRationale": "string"
}

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"
}