{ "openapi": "3.0.1", "info": { "title": "Algolia Website Indexer", "description": "The Indexer crawls recursively a website using the Puppeteer browser (headless Chrome) and indexes the selected pages to the Algolia index.", "version": "0.0", "x-build-id": "7genhiZx9fqtjeScb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apify~algolia-website-indexer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apify-algolia-website-indexer", "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/apify~algolia-website-indexer/runs": { "post": { "operationId": "runs-sync-apify-algolia-website-indexer", "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/apify~algolia-website-indexer/run-sync": { "post": { "operationId": "run-sync-apify-algolia-website-indexer", "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": [ "algoliaAppId", "algoliaApiKey", "algoliaIndexName", "startUrls" ], "properties": { "algoliaAppId": { "title": "Algolia App ID", "type": "string", "description": "Your Algolia Application ID" }, "algoliaApiKey": { "title": "Algolia API Key", "type": "string", "description": "Your Algolia API key" }, "algoliaIndexName": { "title": "Algolia Index Name", "type": "string", "description": "Your Algolia index name" }, "crawlerName": { "title": "Crawler Name", "type": "string", "description": "Crawler name, it updates/removes/adds pages into to index regarding this name. In this case, you can have more website in the index." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs where to start crawling", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "selectors": { "title": "Selectors", "type": "array", "description": "Pick selectors, which text content you want to index. Key is name of attribute and value is CSS selector.", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "requiredAttributes": { "title": "Required attributes", "type": "array", "description": "Pick attributes, which are required in index. By default all attributes from selectors are required." }, "waitForElement": { "title": "Wait for element", "type": "string", "description": "Selector of element to wait on each page." }, "additionalPageAttrs": { "title": "Additional attributes", "type": "object", "description": "Pick additional attributes you want to attach to each record in index.", "default": {} }, "skipIndexUpdate": { "title": "Skip Index Updated", "type": "boolean", "description": "If check crawler will not update Algolia index.", "default": true }, "pseudoUrls": { "title": "Pseudo-URLs", "type": "array", "description": "Overrides default pseudoUrls", "items": { "type": "object", "required": [ "purl" ], "properties": { "purl": { "type": "string", "title": "Pseudo-URL of a web page" } } } }, "pageFunction": { "title": "Page function", "type": "string", "description": "Overrides default pageFunction" }, "clickableElements": { "title": "Clickable elements", "type": "string", "description": "Overrides default clickableElements" }, "keepUrlFragments": { "title": "Keep URL fragments", "type": "boolean", "description": "Option to switch on enqueueing URL with URL fragments", "default": false }, "omitSearchParamsFromUrl": { "title": "Omit search params from URLs", "type": "boolean", "description": "Option to switch off enqueueing with search params.", "default": false } } }, "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 } } } } } } } } } }