{ "openapi": "3.0.1", "info": { "title": "Google AI Overviews & AI Mode Scraper", "description": "Google AI Overviews & AI Mode Scraper SD - Google AI Overviews & AI Mode Scraper is an AI search tool that extracts Google's generative answer for any query: full text, structured blocks, Markdown, cited sources with real URLs, follow-up questions and brand citation checks.", "version": "1.0", "x-build-id": "ajeAt1Pr3erwGKBCv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~google-ai-overviews-ai-mode-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-google-ai-overviews-ai-mode-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/neuro-scraper~google-ai-overviews-ai-mode-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-google-ai-overviews-ai-mode-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/neuro-scraper~google-ai-overviews-ai-mode-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-google-ai-overviews-ai-mode-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", "required": [ "queries" ], "properties": { "queries": { "title": "Search queries", "type": "array", "description": "One query per line, exactly as you would type it into Google, e.g. \"what are the top 5 CRM tools\" or \"best running shoes for flat feet\". A Google search URL (https://www.google.co.uk/search?q=...&hl=en) is accepted too and keeps its own q, hl, gl and domain. Question, comparison and \"best X\" queries trigger the AI answer most often.", "items": { "type": "string" } }, "gl": { "title": "Country (gl)", "type": "string", "description": "Two-letter country code Google answers for, e.g. us, gb, de, in, au.", "default": "us" }, "hl": { "title": "Language (hl)", "type": "string", "description": "Interface / answer language code, e.g. en, de, fr, es, pt-BR.", "default": "en" }, "location": { "title": "Location (city-level, optional)", "type": "string", "description": "Localise the answer to a place, written the way Google names it: City,Region,Country - e.g. \"Chicago,Illinois,United States\" or \"London,England,United Kingdom\". Sent as Google's uule parameter. Empty = country level.", "default": "" }, "googleDomain": { "title": "Google domain", "type": "string", "description": "Which Google to ask, e.g. google.com, google.co.uk, google.de.", "default": "google.com" }, "targetDomains": { "title": "Your domains (citation check, optional)", "type": "array", "description": "Domains to check in every answer, e.g. hubspot.com. Each row then says citationState = cited (a source link is on the domain), mentioned (only the answer text names it) or not_cited, plus the cited domains.", "default": [], "items": { "type": "string" } }, "retryDeferredMaxFetches": { "title": "Re-fetches when the answer is deferred", "minimum": 0, "maximum": 5, "type": "integer", "description": "Google sometimes sends the results page first and loads the AI answer later (deferred). The Actor then asks for the page again, up to this many times (0-5). Each re-fetch is one more Google results page. A query whose answer stays deferred gets no row (not charged) and is named in the run's status message.", "default": 2 }, "includeNoAnswerRows": { "title": "Output queries without an AI answer", "type": "boolean", "description": "On: a query for which Google showed no AI Overview still gets a row (aiOverviewPresent false) - useful for tracking. Off: only answered queries are output.", "default": true }, "includeOrganic": { "title": "Include organic results", "type": "boolean", "description": "Also return the classic organic results of the same search (title, real URL, displayed URL, snippet).", "default": false }, "maxOrganicResults": { "title": "Max organic results per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "With organic results on: how many to collect per query. More than one page (about 10) follows Google's next-page link (start=10, 20 ...) until this number or the last page.", "default": 10 }, "captureRawHtml": { "title": "Save raw HTML", "type": "boolean", "description": "Save each results page's HTML in the run's key-value store (key in rawHtmlKey) - for debugging or your own parsing.", "default": false }, "maxConcurrency": { "title": "Parallel queries", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many queries are fetched at the same time (1-10).", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Google results pages always go through Apify's GOOGLE_SERP proxy (the only route Google answers without a browser). This proxy is used to resolve Google's encrypted source and result links when the direct request is refused.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }