{
  "openapi": "3.0.1",
  "info": {
    "title": "AI Share of Voice - Brand Visibility in LLM Answers",
    "description": "Measure how often AI models recommend your brand: asks GPT, Gemini, Claude, Perplexity and more your buyers' questions, then reports mention rate, list position, share of voice vs competitors, AI-discovered rivals, cited sources and fixes. No API keys.",
    "version": "0.1",
    "x-build-id": "eyJJUvmbVO6Gzb5ly"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/centorprat~ai-share-of-voice/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-centorprat-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/centorprat~ai-share-of-voice/runs": {
      "post": {
        "operationId": "runs-sync-centorprat-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/centorprat~ai-share-of-voice/run-sync": {
      "post": {
        "operationId": "run-sync-centorprat-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"
        ],
        "properties": {
          "brand": {
            "title": "🏷️ Brand",
            "type": "string",
            "description": "The company or product name to track (e.g. \"Notion\")."
          },
          "category": {
            "title": "Category",
            "type": "string",
            "description": "What buyers search for, in plain words (e.g. \"note-taking apps\", \"CRM software for startups\"). Used to generate realistic buyer prompts (discovery, recommendation, alternatives, comparison, budget, perception)."
          },
          "competitors": {
            "title": "Competitors (optional)",
            "type": "array",
            "description": "Competitor names to benchmark against (e.g. \"Evernote\", \"Obsidian\"). The report also lists competitors the AI recommends that you didn't name.",
            "items": {
              "type": "string"
            }
          },
          "brandAliases": {
            "title": "Brand aliases (optional)",
            "type": "array",
            "description": "Other names the models may use for you (product names, old names, abbreviations).",
            "items": {
              "type": "string"
            }
          },
          "brandDomain": {
            "title": "Your domain (optional)",
            "type": "string",
            "description": "e.g. \"notion.com\" - reports whether AI answers cite your site and (with 'Audit my site') tests whether AI bots can read it."
          },
          "auditSite": {
            "title": "Audit my site for AI crawlers",
            "type": "boolean",
            "description": "With a domain set, also test your site the way AI bots see it (robots.txt per AI bot, live bot fetch vs browser, JS-only content, llms.txt, Organization schema) and link the findings to your visibility numbers as root causes. Included in the report price.",
            "default": true
          },
          "prompts": {
            "title": "Your own prompts (optional)",
            "type": "array",
            "description": "Use your own buyer questions instead of the generated set (one per line).",
            "items": {
              "type": "string"
            }
          },
          "engines": {
            "title": "AI engines",
            "type": "array",
            "description": "Which AI engines to ask. API engines (cheap, billed at model cost): 'memory' answer from training data, 'web' search the live web. 'app' engines capture the REAL consumer products (ChatGPT search, Perplexity, Gemini, Copilot, Google AI Mode / AI Overviews) via Apify's own scrapers, billed to your account per prompt (~$0.20; Google AI Overviews ~$0.003). Mixing API + app engines adds an API-vs-app calibration. The form starts with one engine so a first try costs a fraction of a cent.",
            "items": {
              "type": "string",
              "enum": [
                "openai-gpt",
                "google-gemini",
                "anthropic-claude",
                "perplexity-sonar",
                "openai-gpt-web",
                "deepseek",
                "meta-llama",
                "xai-grok",
                "app-google-ai-overview",
                "app-chatgpt",
                "app-perplexity",
                "app-gemini",
                "app-copilot",
                "app-google-ai-mode"
              ],
              "enumTitles": [
                "OpenAI GPT (memory)",
                "Google Gemini (memory)",
                "Anthropic Claude (memory)",
                "Perplexity Sonar (live web + citations)",
                "OpenAI GPT with web search",
                "DeepSeek (memory)",
                "Meta Llama (memory)",
                "xAI Grok (memory)",
                "Google AI Overviews - real SERP (app, ~$0.003/prompt)",
                "ChatGPT search - real app (~$0.20/prompt)",
                "Perplexity - real app (~$0.20/prompt)",
                "Gemini - real app (~$0.20/prompt)",
                "Microsoft Copilot - real app (~$0.20/prompt)",
                "Google AI Mode - real app (~$0.20/prompt)"
              ]
            },
            "default": [
              "openai-gpt",
              "google-gemini",
              "anthropic-claude",
              "perplexity-sonar"
            ]
          },
          "maxPrompts": {
            "title": "Max prompts",
            "minimum": 1,
            "maximum": 40,
            "type": "integer",
            "description": "How many buyer prompts to ask each engine.",
            "default": 8
          },
          "samplesPerPrompt": {
            "title": "Samples per prompt",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "Ask each prompt more than once per engine to average out answer randomness (costs more).",
            "default": 1
          },
          "market": {
            "title": "Market (optional)",
            "type": "string",
            "description": "Country or region to localise the prompts (e.g. \"Germany\")."
          },
          "countryCode": {
            "title": "Country for app engines (optional)",
            "type": "string",
            "description": "Two-letter country code passed to the consumer-app scrapers (e.g. \"us\", \"gb\", \"de\")."
          },
          "includeFullAnswers": {
            "title": "Include full answers",
            "type": "boolean",
            "description": "Also return the full text of every model answer (bigger output).",
            "default": false
          },
          "historyStore": {
            "title": "📈 Track trends: history store (optional)",
            "type": "string",
            "description": "Pick (or create) a key-value store to keep a snapshot per brand+category. Each run then reports what changed since the last run: visibility, mention rate, share of voice, per-engine moves, rising/new competitors, new/dropped cited domains - plus alerts. Schedule the Actor weekly for GEO tracking."
          },
          "webhookUrl": {
            "title": "Webhook URL (optional)",
            "type": "string",
            "description": "If set, the finished report is POSTed here as JSON when the run completes."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}