# AI Brand Visibility Checker (OpenAI) (`lasting_bonnethead/ai-visibility`) Actor

Ask OpenAI models whether they mention your brand (or competitors) for search-style queries. Official OpenAI API only — no website scraping. Returns mention flags, snippets, and confidence per query × model.

- **URL**: https://apify.com/lasting_bonnethead/ai-visibility.md
- **Developed by:** [Fatih S.](https://apify.com/lasting_bonnethead) (community)
- **Categories:** AI, Marketing, Lead generation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $50.00 / 1,000 query results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## AI Brand Visibility Checker (OpenAI)

Ask OpenAI models whether they mention your brand (or competitors) for search-style queries. **Official OpenAI API only** — no ChatGPT website scraping.

### What you get

One dataset row per **query × model** with:

- `mentioned` / `confidence` / `mentionCount`
- `matchedTerms` and optional `competitorsMentioned`
- Answer `snippet`, token usage, rough `costEstimateUsd`

### Inputs

| Field | Notes |
|---|---|
| `brandNames` | Primary brand first, then aliases |
| `queries` | Search-style prompts (hard-capped, default 20 / run) |
| `competitors` | Optional brands to flag in the same answer |
| `models` | Default `gpt-4o-mini` |
| `maxTokens` / `temperature` / `systemPrompt` | Cost and style controls |
| `openaiApiKey` | Optional; prefer the Actor env secret `OPENAI_API_KEY` |

### Pricing

Pay per **query-result** (one row = one query × one model). OpenAI API usage is billed on the key you configure — separate from Store charges.

### Notes

- Bring your own OpenAI API key (Actor secret or input).
- Designed for AI visibility / GEO checks, not for scraping ChatGPT's website.

# Actor input Schema

## `brandNames` (type: `array`):

Primary brand first, then aliases (e.g. "HubSpot", "Hub Spot"). Matching is case-insensitive. Short aliases (≤2 chars) require whole-word matches.

## `queries` (type: `array`):

Search-style prompts to ask the model (e.g. "best payment processors for startups"). Hard-capped at maxQueriesPerRun (default 20).

## `competitors` (type: `array`):

Other brands to flag if mentioned in the same answer.

## `models` (type: `array`):

OpenAI chat model IDs. Default is a cheap model. Each query is run once per model.

## `maxTokens` (type: `integer`):

Caps answer length to control OpenAI cost. Default 400.

## `maxQueriesPerRun` (type: `integer`):

Hard cap on how many queries are processed in one run (after dedupe). Default 20.

## `systemPrompt` (type: `string`):

Override the default system instruction. Leave blank for a neutral product-recommendation style answer.

## `temperature` (type: `number`):

Sampling temperature (0–1). Lower is more deterministic. Default 0.2.

## `openaiApiKey` (type: `string`):

If set, used instead of the Actor's OPENAI_API_KEY environment variable. Prefer leaving this blank and configuring the env secret on the Actor.

## Actor input object example

```json
{
  "brandNames": [
    "Stripe",
    "stripe.com"
  ],
  "queries": [
    "best payment processors for startups",
    "top online payment APIs 2026"
  ],
  "models": [
    "gpt-4o-mini"
  ],
  "maxTokens": 400,
  "maxQueriesPerRun": 20,
  "systemPrompt": "",
  "temperature": 0.2
}
```

# Actor output Schema

## `results` (type: `string`):

No description

## `summary` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "brandNames": [
        "Stripe",
        "stripe.com"
    ],
    "queries": [
        "best payment processors for startups",
        "top online payment APIs 2026"
    ],
    "models": [
        "gpt-4o-mini"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("lasting_bonnethead/ai-visibility").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "brandNames": [
        "Stripe",
        "stripe.com",
    ],
    "queries": [
        "best payment processors for startups",
        "top online payment APIs 2026",
    ],
    "models": ["gpt-4o-mini"],
}

# Run the Actor and wait for it to finish
run = client.actor("lasting_bonnethead/ai-visibility").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "brandNames": [
    "Stripe",
    "stripe.com"
  ],
  "queries": [
    "best payment processors for startups",
    "top online payment APIs 2026"
  ],
  "models": [
    "gpt-4o-mini"
  ]
}' |
apify call lasting_bonnethead/ai-visibility --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,lasting_bonnethead/ai-visibility"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/CDDRkEsUfa70Laa1T/builds/BTC3MQfRLRK19DHPf/openapi.json