# Text Moderation API (`sentinel-moderation/text-moderation-api`) Actor Uses advanced AI models to analyze and classify user-generated content in real time. It detects harmful or inappropriate content, providing category-level flags and confidence scores to help you enforce community guidelines and keep your platform safe. - **URL**: https://apify.com/sentinel-moderation/text-moderation-api.md - **Developed by:** [Sentinel Moderation](https://apify.com/sentinel-moderation) (community) - **Categories:** AI, Automation, Developer tools - **Stats:** 8 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## 🛡️ AI Text Moderation Actor This Apify Actor uses **Sentinel Moderation**'s AI-powered API to classify and flag potentially harmful or inappropriate text content. It detects a wide range of categories including harassment, hate speech, sexual content, illicit activity, self-harm, and violence. Use this actor to help protect your platform and maintain community guidelines by automating content moderation at scale. --- ### 📥 Input Schema The actor accepts a simple JSON input: ```json { "apiKey": "your-sentinelmoderation-api-key", "content": "Text to analyze goes here..." } ```` - `apiKey` *(string, required)*: Your API key from [SentinelModeration.com](https://sentinelmoderation.com). - `content` *(string, required)*: The text you want to classify for moderation. *** ### 📤 Output The actor returns an array containing one moderation result object with the following structure: ```json [ { "flagged": false, "categories": { "harassment": false, "harassment/threatening": false, "sexual": false, "hate": false, "hate/threatening": false, "illicit": false, "illicit/violent": false, "self-harm/intent": false, "self-harm/instructions": false, "self-harm": false, "sexual/minors": false, "violence": false, "violence/graphic": false }, "category_scores": { "harassment": 0.000048, "harassment/threatening": 0.0000066, "sexual": 0.000039, "hate": 0.0000142, "hate/threatening": 0.0000008, "illicit": 0.000022, "illicit/violent": 0.000019, "self-harm/intent": 0.0000011, "self-harm/instructions": 0.0000010, "self-harm": 0.0000020, "sexual/minors": 0.000010, "violence": 0.000016, "violence/graphic": 0.0000056 }, "error": "NOTE: THIS IS A SAMPLE RESPONSE, AN API KEY FROM SENTINELMODERATION.COM IS REQUIRED TO GET REAL RESULTS FOR THIS ACTOR." } ] ``` - `flagged`: `true` if any category crosses the internal moderation threshold. - `categories`: A breakdown of category flags (true/false). - `category_scores`: Raw probability scores for each category (0.0 - 1.0). - `error`: A message shown when a valid API key is not provided. *** ### 🧠 Categories Detected This actor checks for content under the following moderation categories: - **Harassment** - **Threatening language** - **Sexual content (general & involving minors)** - **Hate speech (general & threatening)** - **Illicit activity (including violent)** - **Self-harm (intent, instructions, general)** - **Violence (including graphic imagery)** *** ### 🔐 Getting an API Key To use this actor with real moderation results, you need an API key from **Sentinel Moderation**: 1. Go to [sentinelmoderation.com](https://sentinelmoderation.com) 2. Sign up and generate your API key 3. Use the key in the `apiKey` field of the input *** ### ✅ Example Use Cases - Moderating user comments or posts - Screening support messages for abuse - Filtering harmful prompts in AI chat systems - Pre-checking user-generated bios or profile content # Actor input Schema ## `apiKey` (type: `string`): The API key of your team on Sentinel Moderation. ## `content` (type: `string`): Text content to perform moderation on. ## Actor input object example ```json { "apiKey": "sample-api-key", "content": "...text to classify goes here..." } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "apiKey": "sample-api-key", "content": "...text to classify goes here..." }; // Run the Actor and wait for it to finish const run = await client.actor("sentinel-moderation/text-moderation-api").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "apiKey": "sample-api-key", "content": "...text to classify goes here...", } # Run the Actor and wait for it to finish run = client.actor("sentinel-moderation/text-moderation-api").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "apiKey": "sample-api-key", "content": "...text to classify goes here..." }' | apify call sentinel-moderation/text-moderation-api --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=sentinel-moderation/text-moderation-api", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Text Moderation API", "description": "Uses advanced AI models to analyze and classify user-generated content in real time. It detects harmful or inappropriate content, providing category-level flags and confidence scores to help you enforce community guidelines and keep your platform safe.", "version": "0.0", "x-build-id": "I7Insk8YKdQcKNRzJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sentinel-moderation~text-moderation-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sentinel-moderation-text-moderation-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/sentinel-moderation~text-moderation-api/runs": { "post": { "operationId": "runs-sync-sentinel-moderation-text-moderation-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/sentinel-moderation~text-moderation-api/run-sync": { "post": { "operationId": "run-sync-sentinel-moderation-text-moderation-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "apiKey", "content" ], "properties": { "apiKey": { "title": "API Key from Sentinel Moderation.", "type": "string", "description": "The API key of your team on Sentinel Moderation." }, "content": { "title": "Text to perform moderation on.", "type": "string", "description": "Text content to perform moderation on." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```