{ "openapi": "3.0.1", "info": { "title": "AI Answer Visibility Audit", "description": "Paste a website URL to see whether AI answers recommend that company for real buyer questions, which competitors they name instead, and which sources they cite. Uses the official OpenAI API with web search. Not affiliated with OpenAI.", "version": "0.1", "x-build-id": "SzIxkJHnXKQKWvmP8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/techclout~ai-answer-visibility-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-techclout-ai-answer-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/techclout~ai-answer-visibility-audit/runs": { "post": { "operationId": "runs-sync-techclout-ai-answer-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/techclout~ai-answer-visibility-audit/run-sync": { "post": { "operationId": "run-sync-techclout-ai-answer-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": [ "websiteUrl" ], "properties": { "websiteUrl": { "title": "Website URL", "type": "string", "description": "Homepage of the company to audit. Must be a public http or https URL. Private addresses, localhost, and link-local hosts are rejected." }, "brandName": { "title": "Brand name", "type": "string", "description": "Optional override. When empty, the name is taken from the page or inferred." }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Optional extra names to count as a mention. Matching is case-insensitive and uses word boundaries.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Optional. Leave empty to infer 3 to 5 competitors that are operating now. A services firm is matched with service firms or consultancies of a similar buyer size, not software platforms. A domain that does not resolve, or that redirects to a different company, is dropped. Defunct and acquired brands should not be included." }, "questions": { "title": "Buyer questions", "type": "array", "description": "Optional. Leave empty to infer 5 to 15 unprompted buyer questions. About 40 percent ask who to hire or the best agency or consultant for the category and buyer, about 40 percent are problem or how-to questions, and about 20 percent are comparisons. Those questions do not name the brand.", "items": { "type": "string" } }, "maxQuestions": { "title": "Max questions", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many questions to check, after inference or from the questions you supplied. Default 10. Maximum 25. Free-plan runs are still capped at 3 questions.", "default": 10 }, "engines": { "title": "Engines", "type": "array", "description": "Official APIs to query. openai is the OpenAI Responses API with web search (the default). Gemini and Perplexity are listed for a later release: until they are enabled, selecting one only adds a skipped or error row for that engine, and those rows are not charged. Free-plan runs use only the first 2 selected engines.", "items": { "type": "string", "enum": [ "openai", "gemini", "perplexity" ], "enumTitles": [ "ChatGPT (OpenAI API)", "Gemini (Google API)", "Perplexity API" ] }, "default": [ "openai" ] }, "country": { "title": "Buyer country", "type": "string", "description": "Country context passed to the engines. Default US.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Language the engines should answer in. Default en.", "default": "en" }, "samplesPerQuestion": { "title": "Samples per question", "minimum": 1, "maximum": 3, "type": "integer", "description": "How many times to ask each question on each engine. Answers vary between calls. Each successful sample is charged as engine-answer-checked. Failed calls are not charged. Default 1. Maximum 3. Free-plan runs use 1.", "default": 1 }, "includeReport": { "title": "Include audit report", "type": "boolean", "description": "When true, write the REPORT key with Share of Answer, losing questions, and cited domains as JSON, plus Markdown and HTML copies. Charged as audit-report.", "default": true }, "brandPrompted": { "title": "Brand-prompted questions", "type": "boolean", "description": "When true, add exactly 2 questions that name the brand and the buyer, such as whether the company is a fit and how it compares with other agencies for that work. Those answers are reported separately and are not included in unprompted Share of Answer. Default false.", "default": false }, "timezone": { "title": "Report timezone", "type": "string", "description": "IANA time zone for the date on the Markdown and HTML report, for example America/New_York. Default UTC, which is labeled UTC. The JSON timestamp stays ISO-8601. An unrecognized zone is rejected.", "default": "UTC" }, "uiObservation": { "title": "UI observation", "type": "boolean", "description": "Advanced. Leave off. This Actor does not open consumer chat websites. Turning this on records a notice and still runs the API benchmark only.", "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 }, "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 } } } } } } } } } }