{
  "openapi": "3.0.1",
  "info": {
    "title": "AI Brand Visibility Monitor: ChatGPT and Gemini Share of Voice",
    "description": "Track how often ChatGPT, Perplexity and Gemini recommend your brand vs competitors. Get share of voice, mention rank and cited domains per buyer-intent query — GEO analytics for the AI-search era.",
    "version": "0.1",
    "x-build-id": "TzcgcneR9UuYlnQCP"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/indomitably_doctor~ai-visibility-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-indomitably_doctor-ai-visibility-monitor",
        "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/indomitably_doctor~ai-visibility-monitor/runs": {
      "post": {
        "operationId": "runs-sync-indomitably_doctor-ai-visibility-monitor",
        "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/indomitably_doctor~ai-visibility-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-indomitably_doctor-ai-visibility-monitor",
        "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": [
          "brandName"
        ],
        "properties": {
          "brandName": {
            "title": "Your brand name",
            "type": "string",
            "description": "The brand whose AI visibility you want to measure, e.g. <code>Acme CRM</code>. Matching is case-insensitive and tolerates plurals/possessives."
          },
          "competitors": {
            "title": "Competitor brand names",
            "type": "array",
            "description": "Competitors to benchmark against, e.g. <code>HubSpot</code>, <code>Salesforce</code>.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "queries": {
            "title": "Queries to ask the AI models",
            "type": "array",
            "description": "Buyer-intent questions your prospects ask AI assistants, e.g. <code>What is the best CRM for small businesses?</code>. Leave empty and enable auto-generation to have them created from your topic.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "autoGenerateQueries": {
            "title": "Auto-generate queries from topic",
            "type": "boolean",
            "description": "If enabled and no queries are given, ~10 buyer-intent queries are generated from the <b>Topic</b> field using the first available AI provider.",
            "default": false
          },
          "topic": {
            "title": "Topic / product category",
            "type": "string",
            "description": "Used only for query auto-generation, e.g. <code>CRM software for small businesses</code>."
          },
          "providers": {
            "title": "AI providers to test",
            "type": "array",
            "description": "Which AI assistants to query. Each provider is asked every query.",
            "items": {
              "type": "string",
              "enum": [
                "openai",
                "perplexity",
                "gemini"
              ],
              "enumTitles": [
                "OpenAI (ChatGPT, gpt-4o-mini + web search)",
                "Perplexity (sonar, with citations)",
                "Google Gemini (gemini-2.0-flash + Google Search grounding)"
              ]
            },
            "default": [
              "openai"
            ]
          },
          "apiKeys": {
            "title": "API keys (optional)",
            "type": "object",
            "description": "Optional object with your own keys: <code>{\"openaiApiKey\": \"...\", \"perplexityApiKey\": \"...\", \"geminiApiKey\": \"...\"}</code>. If omitted, keys configured by the Actor owner are used."
          },
          "maxQueries": {
            "title": "Maximum number of queries",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Hard cap on how many queries are processed (each query is sent to every selected provider).",
            "default": 20
          },
          "mockMode": {
            "title": "Mock mode (testing only)",
            "type": "boolean",
            "description": "Skips real API calls and returns deterministic fake answers. For smoke-testing the Actor without API keys.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}