{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility & Share of Voice (Beta)", "description": "Beta. See if Google AI Overviews, ChatGPT, Perplexity and Gemini mention or cite your brand vs competitors for the prompts your buyers ask. Rank, citations, sentiment and share of voice per answer. AI Overviews need no key; LLM modes use your own API keys (you pay the providers' fees).", "version": "0.1", "x-build-id": "HcISrqsKDCzKfgegc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tgelu~ai-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tgelu-ai-visibility-tracker", "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/tgelu~ai-visibility-tracker/runs": { "post": { "operationId": "runs-sync-tgelu-ai-visibility-tracker", "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/tgelu~ai-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-tgelu-ai-visibility-tracker", "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": [ "brand", "prompts" ], "properties": { "brand": { "title": "Your brand", "type": "string", "description": "Brand name as people write it." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other spellings or product names, e.g. 'Notion AI'.", "items": { "type": "string" } }, "brandDomains": { "title": "Brand domains", "type": "array", "description": "Your websites, to detect when an AI cites you as a source.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "One per line: 'Name | alias1, alias2 | domain.com'. Aliases and domains are optional.", "items": { "type": "string" } }, "prompts": { "title": "Prompts", "type": "array", "description": "Questions your buyers ask AI assistants.", "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Google AI Overviews (no API key needed; uses the GOOGLE_SERP proxy) and, with your own API keys (beta), ChatGPT with OpenAI web search, Perplexity Sonar and Gemini with Google Search grounding.", "items": { "type": "string", "enum": [ "chatgpt", "perplexity", "gemini", "google-ai-overview" ], "enumTitles": [ "ChatGPT (beta, your key)", "Perplexity (beta, your key)", "Gemini (beta, your key)", "Google AI Overviews (no key)" ] }, "default": [ "google-ai-overview" ] }, "runsPerPrompt": { "title": "Runs per prompt", "minimum": 1, "maximum": 5, "type": "integer", "description": "AI answers vary; ask each prompt 1–5 times for a stable score.", "default": 1 }, "mode": { "title": "Mode", "enum": [ "byo", "demo" ], "type": "string", "description": "Bring your own API keys (cheapest), or Demo (free, canned sample answers, no keys needed).", "default": "byo" }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "For ChatGPT answers. Billed by OpenAI to you." }, "perplexityApiKey": { "title": "Perplexity API key", "type": "string", "description": "For Perplexity answers. Billed by Perplexity to you." }, "geminiApiKey": { "title": "Google Gemini API key", "type": "string", "description": "For Gemini answers (Google AI Studio key)." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Model used with the web_search tool.", "default": "gpt-4.1-mini" }, "perplexityModel": { "title": "Perplexity model", "type": "string", "description": "e.g. sonar, sonar-pro.", "default": "sonar" }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "e.g. gemini-2.5-flash.", "default": "gemini-2.5-flash" }, "country": { "title": "Country", "type": "string", "description": "Two-letter country for location-aware search (OpenAI, AI Overviews).", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Language code for AI Overviews.", "default": "en" }, "maxAnswers": { "title": "Spend cap: max answers", "minimum": 1, "type": "integer", "description": "Hard stop after this many answers per run (protects your API bill and Apify charges).", "default": 50 }, "includeAnswerText": { "title": "Include full answer text", "type": "boolean", "description": "Store the full AI answer (up to 8,000 chars).", "default": true }, "proxyConfiguration": { "title": "Proxy (AI Overviews only)", "type": "object", "description": "Only used for Google AI Overviews. GOOGLE_SERP proxy is required for reliable results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "GOOGLE_SERP" ] } }, "debugSaveHtml": { "title": "Debug: save raw SERP HTML", "type": "boolean", "description": "Saves each Google results page to the key-value store (for troubleshooting AI Overview parsing).", "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 }, "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 } } } } } } } } } }