Skip to main content
POST /v1/data/llm/brand-mentions/run Pricing: $0.006 per answer ($6.00 per 1,000).

Request

Send the inputs under params. Only the keys below are accepted; any other key returns 422 invalid_params.
string[]
required
One or more prompts. One request reads them all.
string
required
Brand.
string[]
One or more brand aliases. One request reads them all.
string
Brand Website.Format e.g. stripe.com.
string[]
One or more competitors. One request reads them all.
string[]
default:"[\"chatgpt\"]"
Which AI assistants to ask: ChatGPT, Gemini, Google AI Mode, Google AI Overview. Each assistant gives one answer (one row) per prompt, so 3 prompts on 2 assistants is 6 answers. Defaults to ChatGPT.Allowed values: chatgpt (ChatGPT), gemini (Gemini), google_ai_mode (Google AI Mode), google_ai_overview (Google AI Overview).
string
default:"US"
Country the prompts are asked from, e.g. United Kingdom. Defaults to United States.249 allowed values, for example AF (Afghanistan), AL (Albania), DZ (Algeria), AS (American Samoa), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua and Barbuda), AR (Argentina). Fetch the full list with GET /v1/data/llm/brand-mentions?expand=options.

Example

Response fields

Each row in data is one answer, keyed by these fields.

Example response

Abridged: long text and lists are shortened.
For a single assistant answer with sources use ai/answers.