{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Tracker - ChatGPT, Gemini, Perplexity", "description": "See whether ChatGPT, Claude, Gemini and Perplexity recommend your brand. Get mention rate, ranking position, share of voice vs competitors, cited sources and the prompts where you're missing.", "version": "0.1", "x-build-id": "eetSzRj1JgW83XNha" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cywir~ai-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cywir-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/cywir~ai-visibility-tracker/runs": { "post": { "operationId": "runs-sync-cywir-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/cywir~ai-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-cywir-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": "The brand or product name to track, exactly as customers write it." }, "prompts": { "title": "Prompts", "type": "array", "description": "Questions your potential customers ask AI assistants. Write them the way a buyer would, e.g. \"What's the best note-taking app for a small team?\"", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names to compare against. Optional: competitor discovery also finds brands the AI recommends that you didn't list.", "items": { "type": "string" } }, "brandAliases": { "title": "Other names for your brand", "type": "array", "description": "Alternative spellings or product names that should count as your brand, e.g. \"Notion AI\".", "items": { "type": "string" } }, "brandDomain": { "title": "Your website domain", "type": "string", "description": "Used to check whether AI answers cite your site, e.g. notion.com." }, "engines": { "title": "AI engines", "type": "array", "description": "Which AI assistants to ask.", "items": { "type": "string", "enum": [ "chatgpt", "claude", "gemini", "perplexity" ], "enumTitles": [ "ChatGPT (OpenAI)", "Claude (Anthropic)", "Gemini (Google)", "Perplexity" ] }, "default": [ "chatgpt", "claude", "gemini", "perplexity" ] }, "runsPerPrompt": { "title": "Runs per prompt", "minimum": 1, "maximum": 10, "type": "integer", "description": "AI answers vary between runs. Asking each prompt several times gives a more reliable mention rate.", "default": 1 }, "webSearch": { "title": "Let engines search the web", "type": "boolean", "description": "On by default, matching what most users see in ChatGPT, Gemini and Perplexity. Turn off to measure what the model knows from training alone.", "default": true }, "discoverCompetitors": { "title": "Discover competitors automatically", "type": "boolean", "description": "Finds every brand the AI recommends in each answer, so you see who is winning the prompts you lose.", "default": true }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many AI requests run at once. Lower it if you use your own API keys with low rate limits.", "default": 4 }, "chatgptModel": { "title": "ChatGPT model", "type": "string", "description": "Override the OpenAI model." }, "claudeModel": { "title": "Claude model", "type": "string", "description": "Override the Claude model." }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "Override the Gemini model." }, "perplexityModel": { "title": "Perplexity model", "type": "string", "description": "Override the Perplexity model." }, "chatgptApiKey": { "title": "Your OpenAI API key", "type": "string", "description": "Optional. Answers made with your own key are billed at a lower price." }, "claudeApiKey": { "title": "Your Anthropic API key", "type": "string", "description": "Optional. Also used for competitor discovery." }, "geminiApiKey": { "title": "Your Gemini API key", "type": "string", "description": "Optional." }, "perplexityApiKey": { "title": "Your Perplexity API key", "type": "string", "description": "Optional." } } }, "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 } } } } } } } } } }