{ "openapi": "3.0.1", "info": { "title": "Brand Share of Voice in AI Search — Category Benchmark", "description": "AI share of voice: how often ChatGPT, Perplexity and Gemini name your brand vs competitors ($0.08 per prompt). Ranked by mention rate, citation share and position, plus top-cited sources.", "version": "0.1", "x-build-id": "DTW87nJDjTrbJOBOE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/highbrow_fame~ai-brand-share-of-voice/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-highbrow_fame-ai-brand-share-of-voice", "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/highbrow_fame~ai-brand-share-of-voice/runs": { "post": { "operationId": "runs-sync-highbrow_fame-ai-brand-share-of-voice", "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/highbrow_fame~ai-brand-share-of-voice/run-sync": { "post": { "operationId": "run-sync-highbrow_fame-ai-brand-share-of-voice", "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": [ "category" ], "properties": { "category": { "title": "Category", "type": "string", "description": "The product or service category buyers ask about, in the plural or as a noun phrase, for example \"CRM software\", \"project management tools\" or \"running shoes\". The Actor turns it into buyer questions such as \"What are the best project management tools?\"." }, "seedBrands": { "title": "Brands to always include", "type": "array", "description": "Optional. Brands you want in the table even if no answer mentions them (your own brand and your closest rivals). A brand nobody mentions is reported at 0%, which is often the finding.", "default": [], "items": { "type": "string" } }, "country": { "title": "Market (country)", "type": "string", "description": "Two-letter country code for the market, for example us, gb, de, ca, au. For anything except us the generated questions end with \"in \", so the answers and sources are local.", "default": "us" }, "language": { "title": "Answer language", "enum": [ "en", "de", "fr", "es", "it", "pt", "nl", "pl", "hu", "ja" ], "type": "string", "description": "Language the AI engines answer in. The generated questions are always written in English; to benchmark in another language, write your own questions in \"Your own prompts\" below.", "default": "en" }, "promptCount": { "title": "Number of prompts", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many buyer questions to generate and run (1-30). Each one is charged once, when it has been answered and analysed. 8 gives a first picture; 20-30 gives a steadier ranking.", "default": 8 }, "samples": { "title": "Samples per prompt and engine", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many times each prompt is asked on each engine (1-5). AI answers change from one request to the next, so 2 samples smooth out luck. More samples cost us more but not you: the price is per prompt.", "default": 2 }, "engines": { "title": "AI engines", "uniqueItems": true, "type": "array", "description": "Which engines answer the prompts. Perplexity and Gemini (Google Search grounded) run on our keys and are the default. ChatGPT is optional: it costs far more to run, so on our key it gets 1 sample on the first 15 prompts of a run (3 on a free Apify plan); add your own OpenAI key below to run it on every prompt and sample.", "items": { "type": "string", "enum": [ "perplexity-agent", "gemini", "openai" ], "enumTitles": [ "Perplexity (included)", "Google Gemini with Search (included)", "ChatGPT with web search (optional, capped)" ] }, "default": [ "perplexity-agent", "gemini", "openai" ] }, "sampleRun": { "title": "Free sample run (no prompt fees)", "type": "boolean", "description": "Runs at most 3 prompts, 1 sample each, on Perplexity only, and charges no prompt fee, so you can see real output before paying. The platform's small run-start fee still applies.", "default": false }, "customPrompts": { "title": "Your own prompts", "type": "array", "description": "Optional. Questions you want benchmarked instead of the generated ones, in any language (set the answer language to match). Used up to the number of prompts above.", "default": [], "items": { "type": "string" } }, "maxBrands": { "title": "Brands in the table", "minimum": 3, "maximum": 100, "type": "integer", "description": "How many brands to keep in the ranking (3-100). Brands you listed under \"Brands to always include\" are kept regardless.", "default": 25 }, "openaiApiKey": { "title": "Your OpenAI API key (optional)", "type": "string", "description": "Only for ChatGPT. With your own key ChatGPT runs on every prompt and sample, on your OpenAI bill (about $0.012 per call). Without it, ChatGPT is capped as described under AI engines." }, "maxConcurrency": { "title": "Prompts in parallel", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many prompts are processed at the same time (1-6). Lower it if you see rate-limit warnings.", "default": 3 } } }, "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 } } } } } } } } } }