{ "openapi": "3.0.1", "info": { "title": "Keyword Extractor: key phrases from text and pages (YAKE, RAKE)", "description": "Extracts ranked key phrases with scores from many texts, web pages or dataset fields, with YAKE or RAKE, stop word lists for 69 languages, phrase length and near duplicate controls. Runs offline inside the actor.", "version": "0.1", "x-build-id": "sL5ooBh0nJqZbPPmS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~keyword-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-keyword-extractor", "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~keyword-extractor/runs": { "post": { "operationId": "runs-sync-examsens.ai-keyword-extractor", "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~keyword-extractor/run-sync": { "post": { "operationId": "run-sync-examsens.ai-keyword-extractor", "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 document 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 title and main text are analyzed. 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 document. The text 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 read." }, "method": { "title": "Method", "enum": [ "yake", "rake" ], "type": "string", "description": "YAKE weighs where and how words appear (casing, position, frequency, spread, neighbors) and suits single documents. RAKE splits the text at stop words and punctuation and favors longer phrases.", "default": "yake" }, "language": { "title": "Language", "type": "string", "description": "ISO 639-1 code that picks the stop word list, such as en, de or fr. Auto picks the list that matches the text best.", "default": "auto" }, "maxKeywords": { "title": "Keywords per text", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many key phrases to return, best first.", "default": 20 }, "maxWords": { "title": "Longest phrase (words)", "minimum": 1, "maximum": 6, "type": "integer", "description": "Most words in one key phrase.", "default": 3 }, "minWordLength": { "title": "Shortest word (letters)", "minimum": 1, "type": "integer", "description": "Words shorter than this are not used in key phrases.", "default": 3 }, "dedupThreshold": { "title": "Similar phrase cut off", "type": "string", "description": "Drop a phrase whose similarity to a better ranked phrase reaches this value, from 0 to 1. 0.9 removes near duplicates such as plural forms; 1 keeps everything.", "default": "0.9" }, "extraStopwords": { "title": "Extra stop words", "type": "array", "description": "Words that must never start or end a key phrase, added to the language's list, such as your brand name.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }