{ "openapi": "3.0.1", "info": { "title": "AI Visibility Audit - Are You Named by ChatGPT & Perplexity?", "description": "Ask ChatGPT, Perplexity, Gemini and Claude the questions your buyers ask, and measure how often your brand is named, who is named instead, and which sources those answers cite.", "version": "0.1", "x-build-id": "Lyth9GeEO5VCiDNWO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agentbuilt~ai-visibility-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agentbuilt-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/agentbuilt~ai-visibility-audit/runs": { "post": { "operationId": "runs-sync-agentbuilt-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/agentbuilt~ai-visibility-audit/run-sync": { "post": { "operationId": "run-sync-agentbuilt-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": [ "brandName", "category" ], "properties": { "brandName": { "title": "Brand name", "type": "string", "description": "The brand to look for in the answers, exactly as it would be written. Example: Allbirds" }, "domain": { "title": "Website domain", "type": "string", "description": "Used to detect when an assistant cites your site as a source. No protocol needed. Example: linear.app" }, "category": { "title": "Category buyers search for", "type": "string", "description": "The category, not the brand - this is what the questions are built from. Example: project management software for software teams" }, "platforms": { "title": "Assistants to ask", "type": "array", "description": "Which assistants to measure. ChatGPT and Perplexity cover most buyer behaviour; Gemini and Claude cost more per check.", "items": { "type": "string", "enum": [ "chatgpt", "perplexity", "gemini", "claude" ], "enumTitles": [ "ChatGPT (GPT-5)", "Perplexity (Sonar)", "Gemini 2.5 Flash", "Claude Opus 5" ] }, "default": [ "chatgpt", "perplexity" ] }, "prompts": { "title": "Your own questions (optional)", "type": "array", "description": "Leave empty to use buyer-intent questions generated from your category. Supply your own to track exactly the questions you care about.", "default": [], "items": { "type": "string" } }, "maxPrompts": { "title": "Number of questions", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many questions to ask each assistant when prompts are generated for you.", "default": 12 }, "includeAnswers": { "title": "Include the full answer text", "type": "boolean", "description": "Store each assistant's full answer in the dataset so you can read exactly what was said.", "default": true }, "dataForSeoLogin": { "title": "Your DataForSEO login (optional)", "type": "string", "description": "Bring your own DataForSEO account to pay wholesale for the model calls. Leave empty to use ours at the listed price." }, "dataForSeoPassword": { "title": "Your DataForSEO password (optional)", "type": "string", "description": "Only used with your login above, never stored." } } }, "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 } } } } } } } } } }