{ "openapi": "3.0.1", "info": { "title": "Profanity Filter (Bulk, Multi-Language, Leetspeak-Aware)", "description": "Flag or mask profanity & offensive language in bulk text. Catches leetspeak, unicode & spaced obfuscation. Custom wordlist + allowlist. No API keys. Pay per record.", "version": "0.0", "x-build-id": "vL9FHcqc3RCi9c48d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nibble~profanity-content-filter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nibble-profanity-content-filter", "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/nibble~profanity-content-filter/runs": { "post": { "operationId": "runs-sync-nibble-profanity-content-filter", "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/nibble~profanity-content-filter/run-sync": { "post": { "operationId": "run-sync-nibble-profanity-content-filter", "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": [ "records" ], "properties": { "records": { "title": "Text records", "type": "array", "description": "The text records to scan. Each item is either a plain string OR an object { \"id\": , \"text\": \"...\" }. Provide an id to correlate results back to your own rows; otherwise the array index is used. This Actor scans only the text you supply here — it fetches nothing and stores no third-party data." }, "action": { "title": "Action", "enum": [ "mask", "flag" ], "type": "string", "description": "What to do with detected profanity. 'mask' replaces offending characters in the cleaned text; 'flag' leaves the text unchanged and only reports hits. Both modes always return the full hit list.", "default": "mask" }, "maskChar": { "title": "Mask character", "type": "string", "description": "Single character used to replace each offending letter when action is 'mask'. Separators inside a spaced obfuscation (e.g. the spaces in 's h i t') are preserved.", "default": "*" }, "languages": { "title": "Languages", "type": "array", "description": "Which built-in language packs to enable. Leave empty to use all. Options: en (English), es (Spanish), fr (French), de (German).", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Which offense categories to flag. Leave empty for all. Options: profanity, sexual, insult, slur.", "items": { "type": "string" } }, "customWordlist": { "title": "Custom wordlist", "type": "array", "description": "Extra terms to flag in addition to the built-in lists (e.g. brand-specific banned words). Reported under category 'custom'. Obfuscation normalization applies to these too.", "items": { "type": "string" } }, "allowlist": { "title": "Allowlist", "type": "array", "description": "Terms that must NEVER be flagged, even if they match a built-in or custom term (e.g. a surname like 'Dick' or a brand name). Matching is case- and obfuscation-insensitive.", "items": { "type": "string" } }, "maxRecords": { "title": "Max records (cap)", "minimum": 0, "type": "integer", "description": "Optional hard cap on how many records to process this run (0 or empty = no cap). Useful as a cost guard alongside the run's max-charge limit." } } }, "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 } } } } } } } } } }