{
  "openapi": "3.0.1",
  "info": {
    "title": "AI Search Visibility Tracker - ChatGPT, Perplexity & Gemini",
    "description": "Check if ChatGPT, Perplexity, Gemini and Claude mention and cite your brand. Input: prompts, brand name and domains, competitors; no API key needed for ChatGPT. Returns per answer: brand mentioned, position, cited URLs, competitors, answer text. Default: 1 answer per prompt.",
    "version": "1.0",
    "x-build-id": "5jW9yLL2Up1zAlR2W"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kadi_bence~ai-visibility-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kadi_bence-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/kadi_bence~ai-visibility-tracker/runs": {
      "post": {
        "operationId": "runs-sync-kadi_bence-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/kadi_bence~ai-visibility-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-kadi_bence-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",
        "required": [
          "prompts",
          "brandName"
        ],
        "properties": {
          "prompts": {
            "title": "Prompts (questions your buyers ask AI)",
            "type": "array",
            "description": "One question per line, phrased the way a customer would ask ChatGPT, Perplexity, Claude or Gemini, e.g. \"What are the best CRM tools for small agencies?\". Unbranded questions show whether AI recommends you. Up to 1,000 per run; duplicates are skipped.",
            "items": {
              "type": "string"
            }
          },
          "brandName": {
            "title": "Brand name",
            "type": "string",
            "description": "Your brand, product or company as it would appear in an answer, e.g. HubSpot. Matching is whole-word and case-insensitive; spaces, hyphens and dots are interchangeable (Bright Data = BrightData = bright-data)."
          },
          "brandAliases": {
            "title": "Brand aliases",
            "type": "array",
            "description": "Other names that count as a mention of your brand: product names, old names, abbreviations (e.g. HubSpot CRM, Hub Spot).",
            "items": {
              "type": "string"
            }
          },
          "brandDomains": {
            "title": "Brand domains",
            "type": "array",
            "description": "Your website domains, e.g. apify.com. A citation of the domain or any subdomain (docs.apify.com) counts as \"brandCited\". notapify.com does not.",
            "items": {
              "type": "string"
            }
          },
          "competitors": {
            "title": "Competitors",
            "type": "array",
            "description": "One competitor per line: Name | domain.com, other-domain.com | Alias 1, Alias 2. Domains and aliases are optional, e.g. \"Bright Data | brightdata.com | Luminati\". Via the API you can also pass objects {\"name\", \"domains\", \"aliases\"}. Up to 25.",
            "items": {
              "type": "string"
            }
          },
          "providers": {
            "title": "AI assistants to ask",
            "type": "array",
            "description": "Each one is called through its official API with YOUR OWN API key (fields below). OpenAI also works without a key (AI cost included in the price). One check = one prompt x one provider x one run. Other providers without a key are skipped.",
            "items": {
              "type": "string",
              "enum": [
                "openai",
                "perplexity",
                "gemini",
                "anthropic"
              ],
              "enumTitles": [
                "OpenAI (ChatGPT models, with web search)",
                "Perplexity (Agent API, always searches)",
                "Google Gemini (model knowledge, no Search grounding)",
                "Anthropic Claude (with web search)"
              ]
            },
            "default": [
              "openai"
            ]
          },
          "openaiApiKey": {
            "title": "OpenAI API key",
            "type": "string",
            "description": "Optional. With your own key from platform.openai.com > API keys (starts with sk-): $0.01 per check and OpenAI bills you directly for tokens and web searches. Leave empty to use the Actor's own key: $0.035 per check with AI costs included, gpt-6-luna only, max 200 OpenAI checks per run. Stored encrypted by Apify, never logged or written to the output."
          },
          "openaiModel": {
            "title": "OpenAI model",
            "type": "string",
            "description": "Any Responses API model with web search, e.g. gpt-6-luna (cheapest), gpt-6.1-sol, gpt-6-astra. Other models than gpt-6-luna need your own OpenAI key.",
            "default": "gpt-6-luna"
          },
          "perplexityApiKey": {
            "title": "Perplexity API key",
            "type": "string",
            "description": "Your own key from perplexity.ai > API Platform > API keys (starts with pplx-). Stored encrypted, never logged."
          },
          "perplexityModel": {
            "title": "Perplexity preset or model",
            "type": "string",
            "description": "An Agent API preset (fast, low, medium, high) or a provider/model id such as openai/gpt-5.6-luna. \"fast\" is the successor of the retired Sonar model.",
            "default": "fast"
          },
          "geminiApiKey": {
            "title": "Google Gemini API key",
            "type": "string",
            "description": "Your own key from aistudio.google.com > Get API key (starts with AIza). Stored encrypted, never logged. Note: on Google's free tier, Google may use your prompts to improve its products."
          },
          "geminiModel": {
            "title": "Gemini model",
            "type": "string",
            "description": "e.g. gemini-3.8-flash. Gemini answers come from the model's own knowledge: Google's terms do not allow storing or analysing Google Search grounded results, so no citations are collected for Gemini.",
            "default": "gemini-3.8-flash"
          },
          "anthropicApiKey": {
            "title": "Anthropic API key",
            "type": "string",
            "description": "Your own key from platform.claude.com > API keys (starts with sk-ant-). Stored encrypted, never logged."
          },
          "anthropicModel": {
            "title": "Claude model",
            "type": "string",
            "description": "e.g. claude-opus-5-5 (default, most capable), claude-sonnet-5-5 or claude-haiku-4-5 (cheaper).",
            "default": "claude-opus-5-5"
          },
          "webSearch": {
            "title": "Use web search",
            "type": "boolean",
            "description": "On: OpenAI and Claude search the web like ChatGPT search does and return cited sources. Off: answers from model knowledge only (cheaper, no citations). Perplexity presets always search; Gemini never does.",
            "default": true
          },
          "country": {
            "title": "Country",
            "type": "string",
            "description": "Optional 2-letter country code (US, GB, DE...) passed to the web search as the user's approximate location."
          },
          "language": {
            "title": "Answer language",
            "type": "string",
            "description": "Optional, e.g. Deutsch or Italian. Adds a one-line \"Answer in ...\" instruction. Leave empty to let the assistant answer in the prompt's language."
          },
          "runsPerPrompt": {
            "title": "Runs per prompt",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "AI answers vary from call to call. 2-3 runs per prompt give a more reliable visibility %. Each run is a separate check.",
            "default": 1
          },
          "answerMaxChars": {
            "title": "Max answer length stored",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Store at most this many characters of each answer in the dataset (0 = do not store answer text). Analysis always uses the full answer.",
            "default": 4000
          },
          "caseSensitive": {
            "title": "Case-sensitive matching",
            "type": "boolean",
            "description": "Turn on for brand names that are common words (e.g. \"Notion\", \"Box\") so only the capitalized form counts.",
            "default": false
          },
          "monitoring": {
            "title": "Compare with previous run (monitoring)",
            "type": "boolean",
            "description": "Remember results in a named key-value store in your account and add a \"change\" field to every row (new / changed / unchanged: mention gained or lost, position up or down, citation gained or lost). Use with a Schedule.",
            "default": false
          },
          "onlyChanges": {
            "title": "Only output changes",
            "type": "boolean",
            "description": "With monitoring: write only new and changed checks to the dataset. Unchanged checks are still counted (the AI call was made) and appear in SUMMARY.",
            "default": false
          },
          "monitoringId": {
            "title": "Monitoring ID",
            "type": "string",
            "description": "Name for this tracked project, e.g. acme-us-crm. Use a different ID per client or market. Default: derived from the brand name."
          },
          "maxConcurrency": {
            "title": "Parallel API calls",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many API calls run at the same time. Lower it if your API key has low rate limits (429 errors are retried automatically).",
            "default": 5
          },
          "requestTimeoutSecs": {
            "title": "Timeout per API call (seconds)",
            "minimum": 30,
            "maximum": 300,
            "type": "integer",
            "description": "Web-search answers can take 10-60 s. Timeouts are retried up to 3 times.",
            "default": 120
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}