{ "openapi": "3.0.1", "info": { "title": "Google AI Overview Scraper", "description": "Extract rich rendered Google AI Overview answers, citation sources, follow-up questions, and surrounding search result cards.", "version": "1.2", "x-build-id": "10gfSZ7m6Kt3xLvkq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-ai-overview-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-ai-overview-scraper", "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/googleapi~google-ai-overview-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-ai-overview-scraper", "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/googleapi~google-ai-overview-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-ai-overview-scraper", "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": { "queries": { "title": "Search queries", "maxItems": 50, "type": "array", "description": "Search phrases to run on public Google Search result pages. If omitted or empty, the Actor uses the documented sample query.", "items": { "type": "string", "maxLength": 300 }, "default": [ "what is artificial intelligence" ] }, "startUrls": { "title": "Google Search URLs", "maxItems": 100, "type": "array", "description": "Optional public Google /search URLs. When supplied, these replace generated searches; result toggles and limits still apply.", "items": { "type": "object", "properties": { "url": { "title": "Search URL", "description": "Public Google Search /search URL to inspect.", "type": "string", "maxLength": 2000, "pattern": "^https?:\\/\\/(?:www\\.)?google\\.(?:[a-z]{2,3}|(?:co|com)\\.[a-z]{2})\\/search(?:[?#].*)?$" } }, "required": [ "url" ], "additionalProperties": false } }, "language": { "title": "Search language", "maxLength": 20, "type": "string", "description": "Language code used for the Google Search page, such as en or de.", "default": "en" }, "country": { "title": "Search country", "maxLength": 8, "type": "string", "description": "Google country code used for regional results, such as us or gb.", "default": "us" }, "safeSearch": { "title": "SafeSearch", "type": "boolean", "description": "Enable Google's SafeSearch parameter for generated query URLs.", "default": true }, "maxItems": { "title": "Maximum output records", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of query-page records to emit across all supplied queries or start URLs.", "default": 25 }, "maxPages": { "title": "Maximum rendered captures", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum rendered snapshots per query, including the initial page. Additional snapshots scroll the same page to reveal lazy-loaded cards; this does not request Google pagination pages.", "default": 1 }, "page": { "title": "Starting page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "One-based starting Google result page for generated searches. Custom startUrls keep their supplied page parameters.", "default": 1 }, "includePageText": { "title": "Include visible page text", "type": "boolean", "description": "Retain visible text from the Google Search results region, excluding the site-wide account/navigation header. Disabled by default to keep records focused on the extracted answer and result cards.", "default": false }, "includeOrganicResults": { "title": "Include organic results", "type": "boolean", "description": "Include organic search-result cards found on the rendered page.", "default": true }, "includeVideoResults": { "title": "Include video results", "type": "boolean", "description": "Include standalone video result cards. YouTube links used only as AI Overview citations are not treated as video cards.", "default": true }, "includeRelatedQueries": { "title": "Include related questions", "type": "boolean", "description": "Include AI Overview follow-up prompts, People Also Ask questions, and related-search queries when visibly present.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy configuration for permitted public Google requests." } } }, "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 } } } } } } } } } }