{ "openapi": "3.0.1", "info": { "title": "AI Search Visibility Tracker (ChatGPT, Perplexity, Gemini)", "description": "Check if ChatGPT, Perplexity and Gemini mention your brand when people ask about your market. Uses your own API keys and official APIs: one row per prompt and AI with mention, position, competitors and cited sources.", "version": "0.1", "x-build-id": "OSSJud1qO0wcEiFTo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cliqtomedia~ai-search-visibility/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cliqtomedia-ai-search-visibility", "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/cliqtomedia~ai-search-visibility/runs": { "post": { "operationId": "runs-sync-cliqtomedia-ai-search-visibility", "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/cliqtomedia~ai-search-visibility/run-sync": { "post": { "operationId": "run-sync-cliqtomedia-ai-search-visibility", "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": [ "prompts", "brand" ], "properties": { "prompts": { "title": "Prompts", "type": "array", "description": "Questions a buyer might ask an AI assistant, for example \"best CRM for small business\". Up to 100, each up to 2000 characters. Each prompt is asked once per AI.", "items": { "type": "string" } }, "brand": { "title": "Your brand", "type": "string", "description": "Brand name to look for in the answers. Matching is whole-word and case-insensitive." }, "brandAliases": { "title": "Other spellings of your brand", "type": "array", "description": "Optional: other names that count as your brand, for example a product name or \"apify.com\". Up to 10.", "items": { "type": "string" } }, "brandDomain": { "title": "Your website domain", "type": "string", "description": "Optional, for example apify.com. When set, each row tells whether the AI cited a page from this domain (subdomains count) and in which place." }, "competitors": { "title": "Competitors", "type": "array", "description": "Optional competitor names to track in the same answers, up to 25. Add other spellings after a | sign: Bright Data|BrightData.", "items": { "type": "string" } }, "providers": { "title": "AI assistants to check", "type": "array", "description": "Which AIs to ask. Empty = every AI you gave a key for. An AI picked here without a key gets one free api_key_required row telling where to get a key.", "items": { "type": "string", "enum": [ "openai", "perplexity", "gemini" ], "enumTitles": [ "ChatGPT (OpenAI API)", "Perplexity (Agent API)", "Gemini (Google AI Studio API)" ] } }, "geminiApiKey": { "title": "Gemini API key", "type": "string", "description": "Your Google AI Studio key: aistudio.google.com/apikey. Google bills web-search answers to this key. Search (grounding) needs billing enabled on the key's Google Cloud project; the free tier does not include it. Stored encrypted, used only for this run, never written to logs or results." }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Your OpenAI key: platform.openai.com/api-keys. Needs API credits; ChatGPT Plus does not include API use. Stored encrypted, used only for this run, never written to logs or results." }, "perplexityApiKey": { "title": "Perplexity API key", "type": "string", "description": "Your Perplexity key: perplexity.ai/account/api/keys. Needs API credits. Stored encrypted, used only for this run, never written to logs or results." }, "country": { "title": "Country", "type": "string", "description": "Optional two-letter country code, for example US or DE. Sent to OpenAI and Perplexity as the searcher's approximate location. Gemini's API has no location setting, so its rows show countryApplied = false." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Model id with web search support. Empty = gpt-5.4-mini (fast and cheap). Bigger models cost more per answer on your key." }, "perplexityPreset": { "title": "Perplexity preset", "type": "string", "description": "Perplexity Agent API preset. Empty = fast. Other presets may cost more per answer on your key." }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "Gemini model id. Empty = gemini-3.8-flash." } } }, "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 } } } } } } } } } }