{ "openapi": "3.0.1", "info": { "title": "AI Share of Voice: AI Visibility Checker & Report, 4 Assistants", "description": "AI visibility checker and report: ask OpenAI GPT, Grok, Meta AI and Mistral your customers' questions with web search on. Get the brands each names and in what order, your share of answers per assistant, the questions where rivals appear without you, and cited sites.", "version": "0.1", "x-build-id": "X64q3DZNRr6NyuAD8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spokentext~ai-share-of-voice/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spokentext-ai-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/spokentext~ai-share-of-voice/runs": { "post": { "operationId": "runs-sync-spokentext-ai-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/spokentext~ai-share-of-voice/run-sync": { "post": { "operationId": "run-sync-spokentext-ai-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": [ "brand", "questions" ], "properties": { "brand": { "title": "Your brand", "type": "string", "description": "The brand, product or company name to look for in the answers." }, "brandAliases": { "title": "Other spellings of your brand (optional)", "type": "array", "description": "Other names that should count as your brand, such as a longer name or an abbreviation.", "items": { "type": "string" } }, "competitors": { "title": "Competitors", "type": "array", "description": "Other brands to look for, so you can compare how often and how early each one is named.", "items": { "type": "string" } }, "questions": { "title": "Questions", "type": "array", "description": "The questions your customers would ask an AI assistant, one per line, written the way a person would ask. Up to 100 per run.", "items": { "type": "string" } }, "engines": { "title": "AI assistants to ask", "type": "array", "description": "Each question is asked to every assistant chosen here, and each answer is charged once. Leave all four for a full comparison.", "items": { "type": "string", "enum": [ "openai", "grok", "meta", "mistral" ], "enumTitles": [ "OpenAI GPT (gpt-6-luna, the model family behind ChatGPT)", "Grok (xAI)", "Meta AI (Muse Spark)", "Mistral (the company behind Le Chat)" ] }, "default": [ "openai", "grok", "meta", "mistral" ] }, "repeats": { "title": "Times to ask each question", "minimum": 1, "maximum": 5, "type": "integer", "description": "AI answers vary from one time to the next. Asking each question several times gives a steadier share figure. Each repetition is charged as one answer per assistant.", "default": 1 }, "location": { "title": "Location of the person asking (optional)", "type": "string", "description": "A country or city, such as France or New York. The answer is written for someone located there. Leave empty for no particular location." } } }, "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 } } } } } } } } } }