Spam Check

Perform spam check analysis on a given text in seconds.

Body

text · string | array<string> · required

The text to check for spam.

Header

x-api-key · string · required

Your JigsawStack API key

Response

success · boolean

Indicates whether the call was successful.

_usage · object

Usage information for the API call.

Show _usage

input_tokens · number

Number of input tokens processed.

output_tokens · number

Number of output tokens generated.

inference_time_tokens · number

Number of tokens processed during inference time.

total_tokens · number

Total number of tokens used (input + output).

check · object | array<object>

When text is a string, returns an object. When text is an array, returns an array of objects.

Hide check

is_spam · boolean

Indicates whether the text is spam. If the text is not spam, this will be false.

score · number

The spam score of the text. The lower the score, the less likely it will be spam.

Javascript

import { JigsawStack } from "jigsawstack";

const jigsaw = JigsawStack({ apiKey: "your-api-key" });

const response = await jigsaw.validate.spamcheck({
  "text": "Congratulations! You've won a free iPhone! Click here to claim now!"
})

Response

{
  "success": true,
  "check": {
        "score": 0.95,
        "is_spam": true
  },
  "_usage": {
        "input_tokens": 20,
        "output_tokens": 14,
        "inference_time_tokens": 509,
        "total_tokens": 543
  }
}