{ "openapi": "3.0.1", "info": { "title": "Perspective API Alternative: Profanity & Toxicity Check", "description": "Check comments, usernames and chat in bulk for profanity, slurs, insults and threats, with the reason for each. Unprofane, the drop-in Perspective API alternative.", "version": "0.1", "x-build-id": "jx2KDvuOwtjcndKXk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unprofane~perspective-api-alternative/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unprofane-perspective-api-alternative", "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/unprofane~perspective-api-alternative/runs": { "post": { "operationId": "runs-sync-unprofane-perspective-api-alternative", "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/unprofane~perspective-api-alternative/run-sync": { "post": { "operationId": "run-sync-unprofane-perspective-api-alternative", "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" ], "properties": { "apiKey": { "title": "Unprofane API key", "type": "string", "description": "A server key from your Unprofane dashboard: up_test_… (free, no card) or up_live_… (a plan). Get one at https://unprofane.com/signin/. Checks count against that key's plan." }, "texts": { "title": "Texts", "type": "array", "description": "The comments, usernames or messages to check, one per item.", "items": { "type": "string" } }, "datasetId": { "title": "Or: a dataset to read the texts from", "type": "string", "description": "The ID of a dataset, such as another Actor's scraped comments or reviews. Each item's text is read from the field named below; its other fields are copied to the output as `source`." }, "textField": { "title": "Text field in the dataset", "type": "string", "description": "The field holding the text in each dataset item. Dots reach into an object: `comment.body`.", "default": "text" }, "format": { "title": "Output", "enum": [ "unprofane", "perspective" ], "type": "string", "description": "Unprofane: allow, review or block, with the words matched, the disguise each wore and a censored copy. Perspective: TOXICITY, INSULT, PROFANITY and the other scores in Perspective API's shape, for code that already reads them.", "default": "unprofane" }, "context": { "title": "What the texts are", "enum": [ "comment", "chat", "username", "display_name", "review", "gaming", "general" ], "type": "string", "description": "A username is read as one with its words run together; a comment as a sentence.", "default": "comment" }, "policy": { "title": "Audience", "enum": [ "kids", "teen", "standard", "strict", "casual" ], "type": "string", "description": "Who reads the texts: the same text can pass for adults and be held for children.", "default": "standard" }, "mode": { "title": "Mode", "enum": [ "fast", "balanced" ], "type": "string", "description": "Fast: the rules alone, every disguise undone. Balanced: a model reads what the rules cannot settle (insults and threats with no swear word).", "default": "balanced" }, "attributes": { "title": "Perspective attributes", "type": "array", "description": "For the Perspective output only: which scores to return. Empty returns TOXICITY.", "items": { "type": "string", "enum": [ "TOXICITY", "SEVERE_TOXICITY", "IDENTITY_ATTACK", "INSULT", "PROFANITY", "THREAT", "SEXUALLY_EXPLICIT" ] }, "default": [ "TOXICITY", "INSULT", "PROFANITY", "THREAT" ] } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }