POST
/
validate
/
moderation
curl --location 'https://api.ayrshare.com/api/validate/moderation' \
--header 'Authorization: Bearer API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "text": "Let'\''s kill '\''em all"
}'

{
  "status": "success",
  "text": "Let's kill 'em all",
  "moderation": [
    {
      "flagged": true,
      "categories": {
        "sexual": false,
        "hate": false,
        "harassment": false,
        "self-harm": false,
        "sexual/minors": false,
        "hate/threatening": false,
        "violence/graphic": false,
        "self-harm/intent": false,
        "self-harm/instructions": false,
        "harassment/threatening": false,
        "violence": true
      },
      "categoryScores": {
        "sexual": 0.00002128273445123341,
        "hate": 0.027735227718949318,
        "harassment": 0.08523011207580566,
        "self-harm": 0.0000021838018255948555,
        "sexual/minors": 1.924875903114298e-7,
        "hate/threatening": 0.0063302298076450825,
        "violence/graphic": 0.00024857991957105696,
        "self-harm/intent": 7.833968993509188e-7,
        "self-harm/instructions": 8.686130570367823e-8,
        "harassment/threatening": 0.07459623366594315,
        "violence": 0.9833663702011108
      }
    }
  ]
}
Available on Premium, Business, Enterprise plans.
The content moderation API is designed to help developers identify potentially harmful or inappropriate text content. This endpoint analyzes text input and categorizes it based on various types of concerning content.

​
Key Features

  • Automatic detection of harmful content.
  • Multiple categories of problematic text.
  • Easy integration for content filtering.

​
How It Works

When you submit text to the moderation endpoint, it uses OpenAI models to analyze the content. The API then returns results indicating whether the text falls into any of the defined problematic categories.

​
Categories of Harmful Content

The API classifies text into the following categories:
CATEGORYDESCRIPTION
hateContent that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Hateful content aimed at non-protected groups (e.g., chess players) is harassment.
hate/threateningHateful content that also includes violence or serious harm towards the targeted group based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste.
harassmentContent that expresses, incites, or promotes harassing language towards any target.
harassment/threateningHarassment content that also includes violence or serious harm towards any target.
self-harmContent that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders.
self-harm/intentContent where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders.
self-harm/instructionsContent that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts.
sexualContent meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness).
sexual/minorsSexual content that includes an individual who is under 18 years old.
violenceContent that depicts death, violence, or physical injury.
violence/graphicContent that depicts death, violence, or physical injury in graphic detail.

​
Usage and Best Practices

  1. Optimal Text Length: For best results, we recommend splitting long text into smaller chunks. Aim for segments of less than 2,000 characters each.
  2. Integration: Use this API to automatically flag potentially problematic content in your applications, forums, or user-generated content platforms.
  3. Action on Results: Based on the API’s output, you can implement appropriate actions such as content filtering, user warnings, or further review processes.

​
Header Parameters

​
Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY

​
Body Parameters

​
text
string
The text to analyze for moderation.
​
imageUrl
string
The URL of the image. Must begin with https://.
curl --location 'https://api.ayrshare.com/api/validate/moderation' \
--header 'Authorization: Bearer API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "text": "Let'\''s kill '\''em all"
}'

{
  "status": "success",
  "text": "Let's kill 'em all",
  "moderation": [
    {
      "flagged": true,
      "categories": {
        "sexual": false,
        "hate": false,
        "harassment": false,
        "self-harm": false,
        "sexual/minors": false,
        "hate/threatening": false,
        "violence/graphic": false,
        "self-harm/intent": false,
        "self-harm/instructions": false,
        "harassment/threatening": false,
        "violence": true
      },
      "categoryScores": {
        "sexual": 0.00002128273445123341,
        "hate": 0.027735227718949318,
        "harassment": 0.08523011207580566,
        "self-harm": 0.0000021838018255948555,
        "sexual/minors": 1.924875903114298e-7,
        "hate/threatening": 0.0063302298076450825,
        "violence/graphic": 0.00024857991957105696,
        "self-harm/intent": 7.833968993509188e-7,
        "self-harm/instructions": 8.686130570367823e-8,
        "harassment/threatening": 0.07459623366594315,
        "violence": 0.9833663702011108
      }
    }
  ]
}