{ "openapi": "3.0.1", "info": { "title": "AI Visibility Tracker", "description": null, "version": "0.0", "x-build-id": "1aMSp2iBkXXZNLmQf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/agarwoods~ai-visibility-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-agarwoods-ai-visibility-tracker", "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/agarwoods~ai-visibility-tracker/runs": { "post": { "operationId": "runs-sync-agarwoods-ai-visibility-tracker", "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/agarwoods~ai-visibility-tracker/run-sync": { "post": { "operationId": "run-sync-agarwoods-ai-visibility-tracker", "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", "properties": { "brandName": { "title": "Brand name", "type": "string", "description": "The brand to look for in each answer. Matching ignores case and only counts whole words, so Art does not match smart.", "default": "" }, "brandAliases": { "title": "Brand aliases", "type": "array", "description": "Other names that count as your brand, one per line, such as a product name or a short form.", "default": [], "items": { "type": "string" } }, "brandDomain": { "title": "Brand domain", "type": "string", "description": "Your website, such as example.com. A citation counts as yours when its address is this domain or a subdomain of it. Leave empty and brandCited stays empty.", "default": "" }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitor names to look for, one per line. They also set your rank: rank 1 means your brand was the first of these names to appear.", "default": [], "items": { "type": "string" } }, "prompts": { "title": "Prompts", "type": "array", "description": "The questions to ask each model, one per line. Each prompt sent to each model is one check.", "default": [], "items": { "type": "string" } }, "maxChecks": { "title": "Maximum checks", "minimum": 1, "type": "integer", "description": "Stop after this many checks are delivered. This caps what you pay for this Actor, and it also limits what the AI vendors bill to your keys. Failed checks do not count.", "default": 50 }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Your own OpenAI API key. It is stored encrypted, is only sent to api.openai.com, and is never logged or returned. Leave empty to skip OpenAI. OpenAI bills this key separately." }, "anthropicApiKey": { "title": "Anthropic API key", "type": "string", "description": "Your own Anthropic API key. It is stored encrypted, is only sent to api.anthropic.com, and is never logged or returned. Leave empty to skip Anthropic. Anthropic bills this key separately." }, "geminiApiKey": { "title": "Google Gemini API key", "type": "string", "description": "Your own Gemini API key. It is stored encrypted, is only sent to generativelanguage.googleapis.com, and is never logged or returned. Leave empty to skip Gemini. Google bills this key separately." }, "perplexityApiKey": { "title": "Perplexity API key", "type": "string", "description": "Your own Perplexity API key. It is stored encrypted, is only sent to api.perplexity.ai, and is never logged or returned. Leave empty to skip Perplexity. Perplexity bills this key separately." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "The OpenAI model ID to ask. It must support the web search tool. If OpenAI rejects it, you get a status row and the other vendors carry on.", "default": "gpt-6-luna" }, "anthropicModel": { "title": "Anthropic model", "type": "string", "description": "The Claude model ID to ask. If Anthropic rejects it, you get a status row and the other vendors carry on.", "default": "claude-haiku-5-5" }, "geminiModel": { "title": "Gemini model", "type": "string", "description": "The Gemini model ID to ask. It must support Google Search grounding. If Google rejects it, you get a status row and the other vendors carry on.", "default": "gemini-3.8-flash" }, "perplexityModel": { "title": "Perplexity model or effort", "type": "string", "description": "A Perplexity effort level (fast, low, medium, high or xhigh), or a model ID with a slash, such as perplexity/sonar. If Perplexity rejects it, you get a status row and the other vendors carry on.", "default": "fast" } } }, "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 } } } } } } } } } }