{ "openapi": "3.0.1", "info": { "title": "AI Visibility Report — ChatGPT, Perplexity, Claude", "description": "Check if AI assistants recommend your brand when customers ask for advice. See who gets mentioned instead of you, with sources — and what changed since your last check.", "version": "0.1", "x-build-id": "TgfpsZwMI0uUwya5r" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/farodata~ai-visibility-report/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-farodata-ai-visibility-report", "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/farodata~ai-visibility-report/runs": { "post": { "operationId": "runs-sync-farodata-ai-visibility-report", "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/farodata~ai-visibility-report/run-sync": { "post": { "operationId": "run-sync-farodata-ai-visibility-report", "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", "brandUrl" ], "properties": { "brand": { "title": "Brand name", "type": "string", "description": "The brand or company name to check, exactly as customers would know it (e.g. \"Acme Software\")." }, "brandUrl": { "title": "Brand website", "type": "string", "description": "The brand's website. Used to detect the industry, the language, and to generate realistic customer questions." }, "competitors": { "title": "Competitors (optional)", "type": "array", "description": "Competitor brand names to track. Leave empty to let the tool auto-detect who the AIs recommend instead of you.", "default": [], "items": { "type": "string" } }, "queries": { "title": "Custom questions (optional)", "type": "array", "description": "Questions a potential customer would ask an AI assistant. Leave empty to auto-generate realistic buyer-intent questions from the brand's website. Leave empty and we generate them from your website — or reuse the previous run's questions, if you selected one.", "default": [], "items": { "type": "string" } }, "maxQueries": { "title": "Number of questions", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many questions to check. This is the cost dial: each question is checked on every selected AI model, and every successful check is charged. 10 questions x 3 models = 30 checks ($2.69 with the report); 30 x 3 = 90 checks ($7.49). It is also the cap on questions you paste yourself: anything above it is not checked.", "default": 10 }, "models": { "title": "AI models to check", "type": "array", "description": "Which AI assistants to ask. Each question is checked on EVERY selected model, so the number of models multiplies the cost (10 questions × 3 models = 30 checks).", "items": { "type": "string", "enum": [ "chatgpt", "perplexity", "claude" ], "enumTitles": [ "ChatGPT (with web search)", "Perplexity", "Claude (with web search)" ] }, "default": [ "chatgpt", "perplexity", "claude" ] }, "language": { "title": "Language", "enum": [ "auto", "en", "it", "de", "es", "fr" ], "type": "string", "description": "Language for the generated questions and the report. \"auto\" detects it from the brand website.", "default": "auto" }, "previousDataset": { "title": "Previous run results (optional)", "type": "string", "description": "Select the dataset (results) of a previous execution for the same brand. When provided, the report includes what changed since then (new mentions, lost mentions, competitor movements). Tip: use the same questions across runs for a clean comparison. When you select one, the SAME questions are reused automatically so the two runs are comparable — paste your own in \"Custom questions\" to override that." }, "skipReport": { "title": "Skip the insight report", "type": "boolean", "description": "Only run the raw visibility checks, without the interpretive report — saves the $0.29 report fee.", "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 } } }, "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 } } } } } } } } } }