{ "openapi": "3.0.1", "info": { "title": "AI Brand Visibility Monitor — Chinese + Western engines", "description": "Track how AI engines answer about your brand across Chinese (DeepSeek, Qwen, Kimi, GLM) and Western (ChatGPT, Gemini, Claude) engines — mentioned?, sentiment, rank, cited sources, with delta tracking over time. The only Apify actor covering Chinese AI engines.", "version": "0.1", "x-build-id": "h738fNnqxWXB07oAw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zhorex~ai-brand-visibility-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zhorex-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/zhorex~ai-brand-visibility-monitor/runs": { "post": { "operationId": "runs-sync-zhorex-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/zhorex~ai-brand-visibility-monitor/run-sync": { "post": { "operationId": "run-sync-zhorex-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": [ "brand", "prompts" ], "properties": { "brand": { "title": "Brand", "type": "string", "description": "The brand / product / company whose AI visibility you want to track." }, "competitorBrands": { "title": "Competitor brands", "type": "array", "description": "Optional. Each answer is also scanned for these competitors, so you get share-of-voice (you vs rivals) per prompt and engine. Billed as a small per-competitor add-on.", "items": { "type": "string" } }, "prompts": { "title": "Prompts (questions users ask the AI)", "type": "array", "description": "The buyer-intent questions to ask each engine, e.g. 'What are the best running-shoe brands?'. Mix category, comparison and brand questions for coverage. Required.", "items": { "type": "string" } }, "engines": { "title": "AI engines", "type": "array", "description": "Which engines to query. Each needs its own API key supplied in 'API keys' below. The China engines (DeepSeek/Qwen/Kimi/GLM) are the differentiator no other tool covers.", "items": { "type": "string", "enum": [ "deepseek", "qwen", "kimi", "glm", "chatgpt", "gemini", "claude" ], "enumTitles": [ "DeepSeek (China)", "Qwen / Tongyi (China — DashScope key)", "Kimi / Moonshot (China)", "GLM / Zhipu (China)", "ChatGPT / OpenAI", "Gemini / Google", "Claude / Anthropic" ] }, "default": [ "deepseek" ] }, "apiKeys": { "title": "API keys (per engine)", "type": "object", "description": "Your own API keys, keyed by engine name, e.g. {\"deepseek\":\"sk-...\",\"qwen\":\"sk-...\",\"openai\":\"sk-...\"}. Required for every engine you select. With no key supplied the actor returns a free labeled SAMPLE so you can see the output shape. Never logged or stored." }, "deltaMode": { "title": "Delta mode — only what changed since last run", "type": "boolean", "description": "On a schedule with this on, each run returns only checks whose visibility CHANGED (gained/lost mention, sentiment flip, rank move) vs the last run for the same brand — the recurring monitor mode. AI citations are volatile (most brands' citations change week to week), so this is the core use case.", "default": false }, "deltaStateKey": { "title": "Monitor key (delta state)", "type": "string", "description": "Names an independent monitor so multiple scheduled brands don't collide (e.g. 'nike-weekly'). Baseline state persists across runs under this key. Only used when deltaMode is on.", "default": "default" }, "maxChecks": { "title": "Max checks per run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Safety cap on billable checks (1 check = 1 brand x 1 prompt x 1 engine). A 1-brand x 10-prompt x 4-engine audit = 40 checks. Raise for big multi-brand programs.", "default": 200 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave OFF for normal use — the engines are called on their official endpoints directly. Only enable a proxy if a provider geo-restricts your region. Note: routing OpenAI/Anthropic through Apify Proxy datacenter IPs can get those calls blocked, so keep this off unless you specifically need it.", "default": { "useApifyProxy": 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 } } } } } } } } } }