> ## Documentation Index > Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Content Moderation > Check content to ensure it is not harmful or inappropriate export const HeaderAPI = ({noProfileKey, profileKeyRequired}) => <> API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY {!noProfileKey && (profileKeyRequired ? Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY : Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY )} ; export const PlansAvailable = ({plans = [], maxPackRequired}) => { let displayPlans = plans; if (plans && plans.length === 1) { const lowerCasePlan = plans[0].toLowerCase(); if (lowerCasePlan === "basic") { displayPlans = ["Basic", "Premium", "Business", "Enterprise"]; } else if (lowerCasePlan === "business") { displayPlans = ["Business", "Enterprise"]; } else if (lowerCasePlan === "premium") { displayPlans = ["Premium", "Business", "Enterprise"]; } } return Available on {displayPlans.length === 1 ? "the " : ""} {displayPlans.join(", ").replace(/\b\w/g, l => l.toUpperCase())}{" "} {displayPlans.length > 1 ? "plans" : "plan"}. {maxPackRequired && window.open('https://www.ayrshare.com/docs/additional/maxpack', '_self')} className="flex items-center mt-2 cursor-pointer"> Max Pack required } ; }; 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 ## 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: | CATEGORY | DESCRIPTION | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | hate | Content 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/threatening | Hateful 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. | | harassment | Content that expresses, incites, or promotes harassing language towards any target. | | harassment/threatening | Harassment content that also includes violence or serious harm towards any target. | | self-harm | Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders. | | self-harm/intent | Content 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/instructions | Content 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. | | sexual | Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness). | | sexual/minors | Sexual content that includes an individual who is under 18 years old. | | violence | Content that depicts death, violence, or physical injury. | | violence/graphic | Content 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 ## Body Parameters The text to analyze for moderation. The URL of the image. Must begin with `https://`. ```bash cURL theme={"system"} 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" }' ``` ```javascript JavaScript theme={"system"} const url = "https://api.ayrshare.com/api/validate/moderation"; const apiKey = "API_KEY"; // Replace with your actual API key const data = { text: "Let's kill 'em all", }; fetch(url, { method: "POST", headers: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json", }, body: JSON.stringify(data), }) .then((response) => response.json()) .then((result) => console.log(result)) .catch((error) => console.error("Error:", error)); ``` ```python Python theme={"system"} import requests url = 'https://api.ayrshare.com/api/validate/moderation' api_key = 'API_KEY' # Replace with your actual API key headers = { 'Authorization': f'Bearer {api_key}', 'Content-Type': 'application/json' } data = { 'text': "Let's kill 'em all" } response = requests.post(url, json=data, headers=headers) if response.status_code == 200: result = response.json() print(result) else: print(f"Error: {response.status_code}") print(response.text) ``` ```php PHP theme={"system"} "Let's kill 'em all" ]; $headers = [ 'Authorization: Bearer ' . $apiKey, 'Content-Type: application/json' ]; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); $response = curl_exec($ch); if (curl_errno($ch)) { echo 'Error: ' . curl_error($ch); } else { $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); if ($httpCode == 200) { $result = json_decode($response, true); print_r($result); } else { echo "Error: HTTP Code " . $httpCode . "\n"; echo $response; } } ``` ```go Go theme={"system"} package main import ( "bytes" "encoding/json" "fmt" "io/ioutil" "net/http" ) func main() { url := "https://api.ayrshare.com/api/validate/moderation" apiKey := "API_KEY" // Replace with your actual API key // Create the request body requestBody, err := json.Marshal(map[string]string{ "text": "Let's kill 'em all", }) if err != nil { fmt.Println("Error creating request body:", err) return } // Create a new request req, err := http.NewRequest("POST", url, bytes.NewBuffer(requestBody)) if err != nil { fmt.Println("Error creating request:", err) return } // Set headers req.Header.Set("Authorization", "Bearer "+apiKey) req.Header.Set("Content-Type", "application/json") // Send the request client := &http.Client{} resp, err := client.Do(req) if err != nil { fmt.Println("Error sending request:", err) return } defer resp.Body.Close() // Read the response body, err := ioutil.ReadAll(resp.Body) if err != nil { fmt.Println("Error reading response:", err) return } // Check the status code if resp.StatusCode == http.StatusOK { fmt.Println("Response:") fmt.Println(string(body)) } else { fmt.Printf("Error: Status Code %d\n", resp.StatusCode) fmt.Println(string(body)) } } ``` ```csharp C# theme={"system"} using System; using System.Net.Http; using System.Text; using System.Threading.Tasks; using System.Text.Json; class Program { static async Task Main(string[] args) { string url = "https://api.ayrshare.com/api/validate/moderation"; string apiKey = "API_KEY"; // Replace with your actual API key var data = new { text = "Let's kill 'em all" }; using (var client = new HttpClient()) { client.DefaultRequestHeaders.Add("Authorization", $"Bearer {apiKey}"); var content = new StringContent(JsonSerializer.Serialize(data), Encoding.UTF8, "application/json"); try { HttpResponseMessage response = await client.PostAsync(url, content); if (response.IsSuccessStatusCode) { string result = await response.Content.ReadAsStringAsync(); Console.WriteLine("Response:"); Console.WriteLine(result); } else { Console.WriteLine($"Error: {response.StatusCode}"); Console.WriteLine(await response.Content.ReadAsStringAsync()); } } catch (HttpRequestException e) { Console.WriteLine($"Request error: {e.Message}"); Console.WriteLine($"InnerException: {e.InnerException?.Message}"); // Include inner exception details for more information } } } } ``` ```json 200: Response theme={"system"} { "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 } } ] } ``` ```json 400: Bad Request theme={"system"} { "action": "generate", "status": "error", "code": 331, "message": "There was an issue with the AI processing. Please try again and if the issue persists, contact us." } ```