{ "openapi": "3.0.1", "info": { "title": "AI Visibility Audit: ChatGPT, Perplexity & Google Brand Report", "description": "Audit a brand against competitors across AI answers. Generate buyer questions from a website, measure visibility, inspect cited pages and deliver an HTML report with gaps, recommendations and optional run comparisons. $4 per audit plus gateway AI usage.", "version": "0.1", "x-build-id": "8eSIwNgGGEyZB360X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~ai-visibility-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-ai-visibility-audit", "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/zaiq~ai-visibility-audit/runs": { "post": { "operationId": "runs-sync-zaiq-ai-visibility-audit", "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/zaiq~ai-visibility-audit/run-sync": { "post": { "operationId": "run-sync-zaiq-ai-visibility-audit", "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 being audited. Use its actual name for your own audit." }, "website": { "title": "Brand website", "type": "string", "description": "Public homepage URL. Required when questions are omitted; read without login or proxy." }, "category": { "title": "Product category", "type": "string", "description": "Explain what the brand sells and who buys it. Used with the website to generate buyer questions." }, "competitors": { "title": "Competitors", "type": "array", "description": "Up to 10 names, domains or Name | domain entries. The report compares these brands; it does not guess unlisted companies.", "items": { "type": "string" } }, "questions": { "title": "Buyer questions (optional)", "type": "array", "description": "Up to 20 distinct buyer questions. Leave empty to generate questions in one model call using the website and category. Supplied questions skip that call.", "items": { "type": "string" } }, "questionCount": { "title": "Questions to generate", "minimum": 1, "maximum": 20, "type": "integer", "description": "Used only when questions are omitted. One low-cost model call generates this many questions; no silent template fallback.", "default": 20 }, "engines": { "title": "AI engines", "type": "array", "description": "Choose 1 to 3 engines. API answers can differ from consumer apps. Google AI Overview uses the platform SERP route.", "items": { "type": "string", "enum": [ "openai", "perplexity", "gemini", "claude", "grok", "google-ai-overview" ], "enumTitles": [ "ChatGPT (OpenAI GPT, newest model, web search)", "Perplexity (Sonar, web search)", "Google Gemini (newest Flash, Google Search grounding)", "Anthropic Claude (newest Sonnet, web search)", "xAI Grok (newest model, web and X search)", "Google AI Overview (Google's results page)" ] }, "default": [ "openai", "perplexity", "google-ai-overview" ] }, "country": { "title": "Country", "type": "string", "description": "The searcher's country (two-letter code). ChatGPT, Perplexity, Claude and Grok search as from there and Google's AI Overview is read from that country's Google; Gemini does not take a location.", "default": "US" }, "language": { "title": "Google language (optional)", "type": "string", "description": "Language of Google's results page, e.g. en, de, fr, pt-BR. Empty: the country's usual language." }, "projectName": { "title": "Monitoring project (optional)", "type": "string", "description": "Opt in to reports and persistent run history in a named key-value store. Reuse exactly the same project name for comparisons; schedule runs sequentially. Failed or incomparable answers do not become losses." }, "maxCitedPages": { "title": "Cited pages to inspect", "minimum": 0, "maximum": 12, "type": "integer", "description": "Maximum public cited pages read for recommendations when reporting is enabled. Zero uses citation URLs only and labels coverage unknown. No proxy or AI calls are used.", "default": 8 } } }, "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 } } } } } } } } } }