{
  "openapi": "3.0.1",
  "info": {
    "title": "ChatGPT Scraper & AI Search Brand Visibility Tracker",
    "description": "Scrape the answers ChatGPT, Google Gemini and Google AI Overviews give to your prompts, as real logged-out users see them. Markdown answer, cited sources, and brand mention tracking (your brand vs competitors) for GEO / AI search visibility.",
    "version": "0.1",
    "x-build-id": "5yHio2h2XoMgxvSa0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrape-lads~ai-answer-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrape-lads-ai-answer-scraper",
        "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/scrape-lads~ai-answer-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrape-lads-ai-answer-scraper",
        "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/scrape-lads~ai-answer-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrape-lads-ai-answer-scraper",
        "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": [
          "queries"
        ],
        "properties": {
          "queries": {
            "title": "Prompts / search queries",
            "type": "array",
            "description": "The questions to ask each AI engine, written the way your customers would ask them (\"What is the best CRM for a small business?\"). One answer row per prompt and engine.",
            "items": {
              "type": "string"
            }
          },
          "engines": {
            "title": "AI engines",
            "type": "array",
            "description": "Which AI answer engines to ask. ChatGPT and Gemini are asked in a real browser as a logged-out visitor; Google AI Overview is the AI summary at the top of a normal Google results page (not every query gets one).",
            "items": {
              "type": "string",
              "enum": [
                "chatgpt",
                "gemini",
                "google_ai_overview"
              ],
              "enumTitles": [
                "ChatGPT (chatgpt.com, with web search)",
                "Google Gemini (gemini.google.com)",
                "Google AI Overview (google.com results page)"
              ]
            },
            "default": [
              "chatgpt",
              "gemini",
              "google_ai_overview"
            ]
          },
          "brandName": {
            "title": "Your brand",
            "type": "string",
            "description": "The brand whose AI visibility you track, e.g. \"HubSpot\". Matched case-insensitively on whole words."
          },
          "brandDomain": {
            "title": "Your website domain",
            "type": "string",
            "description": "e.g. hubspot.com. Citations on this domain or any subdomain count as your site being cited (isCitedAsSource)."
          },
          "brandAliases": {
            "title": "Brand aliases",
            "type": "array",
            "description": "Other names for your brand: product names, old names, common spellings (\"HubSpot CRM\", \"Hubspot Sales Hub\").",
            "items": {
              "type": "string"
            }
          },
          "competitors": {
            "title": "Competitors",
            "type": "array",
            "description": "One competitor per line. Add aliases or the website after a |: \"Zoho CRM | Zoho | zoho.com\". Used for rank among brands, share of voice and competitor citations.",
            "items": {
              "type": "string"
            }
          },
          "competitorDomains": {
            "title": "Competitor domains (optional)",
            "type": "array",
            "description": "Competitor websites, if you did not add them after a | above. Each domain is paired with the competitor whose name matches it, otherwise in list order.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "enum": [
              "US",
              "GB",
              "CA",
              "AU",
              "IE",
              "NZ",
              "IN",
              "DE",
              "FR",
              "ES",
              "IT",
              "NL",
              "SE",
              "BR",
              "MX",
              "JP",
              "SG",
              "AE",
              "ZA"
            ],
            "type": "string",
            "description": "Where the questions are asked from: proxy exit country and Google's gl parameter. Answers and sources differ by country.",
            "default": "US"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Interface language (Google hl, Gemini hl, browser language), e.g. en, de, fr, es. Write your prompts in the same language.",
            "default": "en"
          },
          "includeSummary": {
            "title": "Add a summary report row",
            "type": "boolean",
            "description": "Adds one row (recordType \"summary\") with your visibility score 0-100 (40% mention rate, 30% position, 20% share of voice, 10% citation rate), a per-engine breakdown, competitor metrics, the most cited domains and your most cited pages. Free.",
            "default": true
          },
          "includeOrganicResults": {
            "title": "Google: include organic top 10 and People Also Ask",
            "type": "boolean",
            "description": "Google AI Overview rows also get the organic results and People Also Ask questions from the same results page, at no extra cost.",
            "default": true
          },
          "analyzeSentiment": {
            "title": "Brand stance and attributes (AI)",
            "type": "boolean",
            "description": "A small LLM reads each answer and labels every mentioned brand as recommended, neutral or warned against, with 3-5 attributes the answer uses (\"free plan\", \"steep learning curve\"). Included in the answer price.",
            "default": false
          },
          "fanOutVariants": {
            "title": "Query fan-out: variants per prompt",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Generate this many rewordings of each prompt (budget, use case, comparison angles) and ask them too, like the fan-out AI engines do internally. Each variant is a normal answer per engine.",
            "default": 0
          },
          "maxBudgetUsd": {
            "title": "Max budget (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Safety cap: the run estimates its cost up front and skips answers that would go over this amount. Leave empty to use the run's normal spending limit."
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "Optional. When the run finishes, a POST with the run id, the dataset URL, the run summary and the report row is sent here (e.g. Zapier, Make, n8n, Slack workflow)."
          },
          "demoMode": {
            "title": "Demo / health check (free)",
            "type": "boolean",
            "description": "Runs only the first prompt on each engine and charges nothing. Use it to check the engines respond before a big run.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Browser tabs in parallel",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "How many ChatGPT / Gemini prompts run at the same time (split between the engines). More is faster but needs more memory: about 1 per GB.",
            "default": 2
          },
          "maxRetries": {
            "title": "Retries per prompt",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "When an engine refuses or times out, the prompt is retried on a fresh browser session and IP this many times. Failed rows are free.",
            "default": 2
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}