{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Monitor", "description": "Track how any brand appears across ChatGPT, Perplexity, Claude, and Gemini. BYO API keys.", "version": "0.0", "x-build-id": "dxhJKeWBweCbm4qWd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xanthic_smock~ai-brand-visibility-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xanthic_smock-ai-brand-visibility-monitor", "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/xanthic_smock~ai-brand-visibility-monitor/runs": { "post": { "operationId": "runs-sync-xanthic_smock-ai-brand-visibility-monitor", "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/xanthic_smock~ai-brand-visibility-monitor/run-sync": { "post": { "operationId": "run-sync-xanthic_smock-ai-brand-visibility-monitor", "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" ], "properties": { "brandName": { "title": "Brand Name", "type": "string", "description": "The brand, company, or product name to research." }, "query": { "title": "Custom Query (optional)", "type": "string", "description": "Custom question. Use {brand} as placeholder." }, "useOpenai": { "title": "OpenAI (ChatGPT)", "type": "boolean", "description": "Query ChatGPT about the brand.", "default": true }, "usePerplexity": { "title": "Perplexity", "type": "boolean", "description": "Query Perplexity (brings web citations).", "default": true }, "useAnthropic": { "title": "Anthropic (Claude)", "type": "boolean", "description": "Query Claude about the brand.", "default": true }, "useGoogle": { "title": "Google (Gemini)", "type": "boolean", "description": "Query Gemini about the brand.", "default": true }, "maxTokens": { "title": "Max Response Tokens", "minimum": 256, "maximum": 8192, "type": "integer", "description": "Maximum tokens per AI response. Higher = more detailed answers (costs more).", "default": 2048 }, "openaiApiKey": { "title": "OpenAI API Key", "type": "string", "description": "Required if OpenAI is selected. Get one at https://platform.openai.com/api-keys" }, "openaiModel": { "title": "OpenAI Model", "enum": [ "gpt-4o", "gpt-4o-mini", "gpt-4-turbo", "o4-mini" ], "type": "string", "description": "Model for OpenAI queries.", "default": "gpt-4o" }, "perplexityApiKey": { "title": "Perplexity API Key", "type": "string", "description": "Required if Perplexity is selected. Get one at https://www.perplexity.ai/settings/api" }, "perplexityModel": { "title": "Perplexity Model", "enum": [ "sonar-pro", "sonar", "sonar-reasoning-pro", "sonar-reasoning" ], "type": "string", "description": "Model for Perplexity queries.", "default": "sonar-pro" }, "anthropicApiKey": { "title": "Anthropic (Claude) API Key", "type": "string", "description": "Required if Anthropic is selected. Get one at https://console.anthropic.com/settings/keys" }, "anthropicModel": { "title": "Claude Model", "enum": [ "claude-sonnet-4-20250514", "claude-3-5-sonnet-20241022", "claude-3-5-haiku-20241022", "claude-opus-4-20250514" ], "type": "string", "description": "Model for Claude queries.", "default": "claude-sonnet-4-20250514" }, "googleApiKey": { "title": "Google (Gemini) API Key", "type": "string", "description": "Required if Google is selected. Get one at https://aistudio.google.com/apikey" }, "googleModel": { "title": "Gemini Model", "enum": [ "gemini-2.5-flash", "gemini-2.5-pro", "gemini-2.0-flash" ], "type": "string", "description": "Model for Gemini queries.", "default": "gemini-2.5-flash" } } }, "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 } } } } } } } } } }