{ "openapi": "3.0.1", "info": { "title": "Grammar and Spelling Checker: bulk texts and web pages", "description": "Checks many texts, web pages or dataset fields for spelling, grammar, punctuation and style issues in more than 20 languages with the open source LanguageTool, run inside the actor. Returns each issue with its position and suggestions, counts by kind, and a corrected text.", "version": "0.1", "x-build-id": "S6N0UbBgSQoCvI9nA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~grammar-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-grammar-checker", "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/examsens.ai~grammar-checker/runs": { "post": { "operationId": "runs-sync-examsens.ai-grammar-checker", "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/examsens.ai~grammar-checker/run-sync": { "post": { "operationId": "run-sync-examsens.ai-grammar-checker", "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", "properties": { "texts": { "title": "Texts", "type": "array", "description": "One text per entry.", "items": { "type": "string" } }, "items": { "title": "Texts with IDs", "type": "array", "description": "JSON objects with \"text\" and any other fields, such as an \"id\". The other fields are copied to the result." }, "urls": { "title": "Web pages", "type": "array", "description": "Pages whose main text is checked. Menus, footers and scripts are left out.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "datasetIds": { "title": "Apify datasets", "type": "array", "description": "Datasets in your account; each item is one text. The field is found for you (text, markdown, content, body, description, article, review, comment), or set it below." }, "textField": { "title": "Dataset text field", "type": "string", "description": "Field of each dataset item to check." }, "language": { "title": "Language", "type": "string", "description": "auto detects each text's language. Or give a code such as en-US, en-GB, de-DE, fr, es, pt-BR, nl, it, pl. A regional code such as en-US also checks spelling for that region.", "default": "auto" }, "preferredVariants": { "title": "Preferred variants", "type": "array", "description": "With auto, the regional spelling to use for each language, such as en-GB or de-AT.", "items": { "type": "string" } }, "motherTongue": { "title": "Writer's first language", "type": "string", "description": "Code such as de or fr. Turns on the false friend checks between that language and the text's language." }, "picky": { "title": "Picky mode", "type": "boolean", "description": "Also apply the stricter style and typography rules.", "default": false }, "disabledRules": { "title": "Rules to skip", "type": "array", "description": "Rule IDs to turn off, as shown in ruleId of the results, such as WHITESPACE_RULE or UPPERCASE_SENTENCE_START.", "items": { "type": "string" } }, "disabledCategories": { "title": "Categories to skip", "type": "array", "description": "Category IDs to turn off, such as TYPOS (spelling), STYLE, TYPOGRAPHY, CASING or REDUNDANCY.", "items": { "type": "string" } }, "ignoreWords": { "title": "Words to accept", "type": "array", "description": "Words and names that are never reported, such as product and brand names.", "items": { "type": "string" } }, "maxIssues": { "title": "Issues listed per text", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Most issues to list for one text. The counts always cover every issue.", "default": 200 }, "correctedText": { "title": "Add corrected text", "type": "boolean", "description": "Add the text with the first suggestion of each issue applied.", "default": true } } }, "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 } } } } } } } } } }