{
  "openapi": "3.0.1",
  "info": {
    "title": "AI Visibility Tracker — ChatGPT, Perplexity, Gemini · $0.03",
    "description": "Check if ChatGPT, Perplexity, Gemini and Claude recommend your brand: mention rate, position, competitors, cited sources and tone. Built-in Claude with live web search ($0.03/check, no key) or your own keys ($0.01).",
    "version": "1.0",
    "x-build-id": "FmXAMbNjFr4mIXSTG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tidydata~ai-brand-visibility-tracker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tidydata-ai-brand-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/tidydata~ai-brand-visibility-tracker/runs": {
      "post": {
        "operationId": "runs-sync-tidydata-ai-brand-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/tidydata~ai-brand-visibility-tracker/run-sync": {
      "post": {
        "operationId": "run-sync-tidydata-ai-brand-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": {
          "brand": {
            "title": "Your brand",
            "type": "string",
            "description": "The brand, product or company to look for in AI answers."
          },
          "brandDomain": {
            "title": "Your website",
            "type": "string",
            "description": "Optional. Your domain (e.g. hubspot.com) to see if the AI cites your site as a source."
          },
          "brandAliases": {
            "title": "Other names of your brand",
            "type": "array",
            "description": "Optional. Other spellings or product names that count as your brand (e.g. 'HubSpot CRM').",
            "items": {
              "type": "string"
            }
          },
          "competitors": {
            "title": "Competitors",
            "type": "array",
            "description": "Optional. Competitors to compare against (up to 20). Every other brand the AI recommends is listed anyway.",
            "items": {
              "type": "string"
            }
          },
          "prompts": {
            "title": "Questions",
            "type": "array",
            "description": "The questions your buyers ask AI assistants, in any language (up to 200). Leave empty and fill 'Category' to have them written for you.",
            "items": {
              "type": "string"
            }
          },
          "category": {
            "title": "Category (to write the questions for you)",
            "type": "string",
            "description": "Used only when 'Questions' is empty. What you sell, e.g. 'CRM for small businesses' or 'vegan protein powder in Spain'."
          },
          "autoPromptCount": {
            "title": "How many questions to write",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Used with 'Category'.",
            "default": 5
          },
          "promptLanguage": {
            "title": "Language of the written questions",
            "type": "string",
            "description": "Used with 'Category'. E.g. English, Spanish, German.",
            "default": "English"
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Optional. City or country of the buyer (e.g. 'Madrid, Spain'). Answers are localized like for a real user there."
          },
          "engines": {
            "title": "AI assistants",
            "type": "array",
            "description": "The built-in AI (Claude with live web search) is included — no key needed. You can add ChatGPT, Perplexity, Gemini or Claude with your own API key (you pay those providers directly), or a free Groq key.",
            "items": {
              "type": "string",
              "enum": [
                "built-in",
                "groq",
                "chatgpt",
                "perplexity",
                "gemini",
                "claude"
              ],
              "enumTitles": [
                "Built-in AI: Claude with live web search (included)",
                "GPT-OSS with web search (your free Groq key)",
                "ChatGPT (your OpenAI key)",
                "Perplexity (your Perplexity key)",
                "Gemini (your Google AI key)",
                "Claude (your Anthropic key)"
              ]
            },
            "default": [
              "built-in"
            ]
          },
          "repeats": {
            "title": "Ask each question how many times",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "AI answers vary. Ask 2-3 times for a more reliable mention rate (each repeat is a check).",
            "default": 1
          },
          "includeAnswer": {
            "title": "Include the full AI answer",
            "type": "boolean",
            "description": "Keep the AI's full answer text in the results.",
            "default": true
          },
          "groqApiKey": {
            "title": "Groq API key (free)",
            "type": "string",
            "description": "Free at console.groq.com/keys. Runs an OpenAI open-weight model with live web search on your own free quota."
          },
          "openaiApiKey": {
            "title": "OpenAI API key",
            "type": "string",
            "description": "For ChatGPT answers with web search (Responses API)."
          },
          "perplexityApiKey": {
            "title": "Perplexity API key",
            "type": "string",
            "description": "For Perplexity Sonar answers with sources."
          },
          "geminiApiKey": {
            "title": "Google AI (Gemini) API key",
            "type": "string",
            "description": "From Google AI Studio. Answers use Google Search grounding."
          },
          "anthropicApiKey": {
            "title": "Anthropic API key",
            "type": "string",
            "description": "For Claude answers with web search."
          },
          "groqModel": {
            "title": "Groq model",
            "type": "string",
            "description": "Default openai/gpt-oss-20b (switches to openai/gpt-oss-120b when its daily quota is used)."
          },
          "chatgptModel": {
            "title": "ChatGPT model",
            "type": "string",
            "description": "Default gpt-5-mini."
          },
          "perplexityModel": {
            "title": "Perplexity model",
            "type": "string",
            "description": "Default sonar."
          },
          "geminiModel": {
            "title": "Gemini model",
            "type": "string",
            "description": "Default gemini-2.5-flash."
          },
          "claudeModel": {
            "title": "Claude model",
            "type": "string",
            "description": "Default claude-opus-5-5. claude-sonnet-5-5 or claude-haiku-5-5 cost less."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}