{ "openapi": "3.0.1", "info": { "title": "AI Visibility Monitor: ChatGPT, Perplexity & Gemini", "description": "Check whether AI search engines recommend your brand. Get mention rate, ranking position, share of voice vs competitors and the sources AI cites.", "version": "0.1", "x-build-id": "nH17tyIZRV0ugOzNl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/matidepa22~ai-visibility-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-matidepa22-ai-visibility-monitor", "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/matidepa22~ai-visibility-monitor/runs": { "post": { "operationId": "runs-sync-matidepa22-ai-visibility-monitor", "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/matidepa22~ai-visibility-monitor/run-sync": { "post": { "operationId": "run-sync-matidepa22-ai-visibility-monitor", "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" ], "properties": { "brand": { "title": "Brand name", "type": "string", "description": "The brand, product or company to track." }, "topic": { "title": "Topic (auto-generate prompts)", "type": "string", "description": "Describe your market, e.g. \"CRM for small agencies\" or \"billeteras virtuales en Argentina\". The Actor writes realistic buyer questions for you (free). Leave empty to use only your own prompts." }, "promptCount": { "title": "Prompts to generate", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many questions to generate from the topic. Each one is sent to every selected engine.", "default": 10 }, "prompts": { "title": "Prompts", "type": "array", "description": "Your own questions (optional if you set a topic). Each prompt is sent to every selected engine.", "items": { "type": "string" } }, "runsPerPrompt": { "title": "Runs per prompt", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many times each prompt is asked to each engine. AI answers change a lot between identical requests, so the share of runs where you appear is far more reliable than a single answer. 3–5 is a good balance; each run is one billed check.", "default": 3 }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names to compare against. Add other names AI may use after a | sign, e.g. \"Rivadavia Seguros | Seguros Rivadavia\".", "items": { "type": "string" } }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other spellings or product names that count as a mention of your brand.", "items": { "type": "string" } }, "autoAliases": { "title": "Auto-detect name variants", "type": "boolean", "description": "Add common unambiguous variants for your brand and competitors (e.g. \"UTDT\" for Universidad Torcuato Di Tella), so mentions under another name aren't missed. Free; the list used is saved in the summary.", "default": true }, "brandDomains": { "title": "Brand domains", "type": "array", "description": "Your websites (e.g. notion.so). Used to detect when AI cites you as a source.", "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Which AI search engines to query.", "items": { "type": "string", "enum": [ "openai", "perplexity", "gemini" ], "enumTitles": [ "ChatGPT (OpenAI, web search)", "Perplexity", "Gemini (Google Search grounding)" ] }, "default": [ "openai", "perplexity", "gemini" ] }, "analyzeSentiment": { "title": "Analyze sentiment", "type": "boolean", "description": "Classify each mention as positive, neutral or negative (free, uses OpenAI).", "default": true }, "country": { "title": "Country (ISO code)", "type": "string", "description": "Two-letter country code to localize web search, e.g. US, AR, ES. Not supported by every engine." }, "generateReport": { "title": "Generate client-ready report", "type": "boolean", "description": "Save a formatted HTML report (summary, recommendations, prompt-by-prompt table, sources) as REPORT in the key-value store. Print it to PDF from your browser to send to clients.", "default": true }, "reportLanguage": { "title": "Report language", "enum": [ "auto", "en", "es" ], "type": "string", "description": "Language of the report and its written summary.", "default": "auto" }, "agencyName": { "title": "Agency name (white-label)", "type": "string", "description": "Optional. Shown as \"Prepared by \" at the top of the report, so agencies can send it to clients as their own." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many AI requests run in parallel.", "default": 4 }, "openaiApiKey": { "title": "Your OpenAI API key (optional)", "type": "string", "description": "Bring your own key for a lower price per check. Leave empty to use ours." }, "perplexityApiKey": { "title": "Your Perplexity API key (optional)", "type": "string", "description": "Bring your own key for a lower price per check. Leave empty to use ours." }, "geminiApiKey": { "title": "Your Gemini API key (optional)", "type": "string", "description": "Bring your own key for a lower price per check. Leave empty to use ours." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Override the OpenAI model used for web search." }, "perplexityPreset": { "title": "Perplexity preset", "type": "string", "description": "Perplexity Agent API preset (fast, low, medium, high)." }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "Override the Gemini model used for Google Search grounding." } } }, "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 } } } } } } } } } }