{ "openapi": "3.0.1", "info": { "title": "Ai Visibility Checker", "description": "Measure how visible a brand is inside AI-generated answers across ChatGPT, Gemini, Claude, and Perplexity.\n\nFor every question you provide, this Actor asks each selected AI answer engine, waits for the\nresponse to finish streaming, and extracts a structured record", "version": "1.0", "x-build-id": "qqvhi4lE2aa1ickb3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammad-bilal~ai-visibility-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammad-bilal-ai-visibility-checker", "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/muhammad-bilal~ai-visibility-checker/runs": { "post": { "operationId": "runs-sync-muhammad-bilal-ai-visibility-checker", "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/muhammad-bilal~ai-visibility-checker/run-sync": { "post": { "operationId": "run-sync-muhammad-bilal-ai-visibility-checker", "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", "questions" ], "properties": { "brand": { "title": "Brand", "type": "string", "description": "The brand whose visibility inside AI answers you want to measure." }, "industry": { "title": "Industry", "type": "string", "description": "Industry / category context used to ground the questions (e.g. 'CRM software')." }, "country": { "title": "Country", "type": "string", "description": "Target market/geography context (e.g. 'United States')." }, "questions": { "title": "Questions", "type": "array", "description": "Questions to ask each AI platform. Each question is asked on every selected platform.", "items": { "type": "string" } }, "platforms": { "title": "AI Platforms", "type": "array", "description": "Which AI answer engines to query. Leave empty to query all four.", "items": { "type": "string", "enum": [ "ChatGPT", "Gemini", "Claude", "Perplexity" ] }, "default": [ "ChatGPT", "Gemini", "Claude", "Perplexity" ] }, "knownCompetitors": { "title": "Known Competitors", "type": "array", "description": "Optional list of known competitors to improve position/competitor detection accuracy.", "default": [], "items": { "type": "string" } }, "headless": { "title": "Headless browser", "type": "boolean", "description": "Run the browser in headless mode.", "default": true }, "screenshotOnFailure": { "title": "Screenshot on failure", "type": "boolean", "description": "Capture a screenshot to the Key-Value Store when an answer cannot be obtained.", "default": true }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of retry attempts per (platform, question) on transient failures.", "default": 2 }, "askTimeoutMs": { "title": "Ask timeout (ms)", "minimum": 15000, "maximum": 180000, "type": "integer", "description": "Maximum time to wait for a single answer to complete.", "default": 90000 }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route browser traffic through Apify Proxy (residential group preferred).", "default": true }, "cookies": { "title": "Session cookies", "type": "array", "description": "Optional array of cookies (name/value/domain/path) to authenticate sessions on platforms that require login.", "default": [] }, "mockMode": { "title": "Mock / demo mode", "type": "boolean", "description": "Run fully offline with deterministic synthetic answers (no browser, no auth). Useful for demos, testing, and example runs.", "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 } } } } } } } } } }