Browse the documentation

MentionBird.ai API

Read how AI assistants talk about your brand — visibility, share of voice, the pages they cite, and the searches they run — and add brands or prompts to track.

Get started

Create an API key in your workspace settings.
Send it as a bearer token on every request. See Authentication.
Call List Tracked Brands first — most endpoints take a brand name exactly as it returns it.

Base URL https://app.mentionbird.ai/api/v1

Using this API with an AI assistant

The full OpenAPI 3.0 description lives at openapi.json. Point a ChatGPT Custom GPT Action or a Gemini Extension at that URL and every endpoint below becomes available to it.

If your client speaks MCP instead, connect it to https://mcp.mentionbird.ai/mcp with the same API key.

Discovery

Find the brands, prompts, tags and AI platforms this workspace tracks. Start here — most other endpoints take a brand name or prompt ID returned by these.

GET List Tracked Brands List every brand this workspace tracks. Call this first — other endpoints take the brand name exactly as returned here. /brands/tracked GET List Tracked Prompts List the prompts tracked for a brand, with their search-volume and difficulty buckets and the prompt ID token other endpoints need. /queries GET List Prompt Tags List the tags this workspace has assigned to a brand's prompts. Pass a tag's slug as `query_tag` on other endpoints. /queries/tags GET List AI Platforms List the AI platforms available to this workspace (ChatGPT, Claude, Gemini, Perplexity, Grok) and the models behind them. /llm-providers

Visibility

How often the brand appears in AI answers, and who it shares those answers with.

GET Get Brand Visibility How often the brand appears in AI answers, plus prominence score, average rank and sentiment. Group overall, by day, by platform or by tag. /visibility GET Get Share of Voice The brands named most often across this brand's tracked prompts — who you are losing to, and by how much. /brands/top-mentioned

Citations

The pages and domains AI platforms cite when they answer, and how much of that is your own.

GET Get Top Cited Domains The domains AI platforms cite most when answering this brand's prompts. /citations/domains GET List Citations Individual cited URLs with page metadata, for detailed source analysis. /citations GET List Citation Taxonomy The valid source_type and content_type values to pass to the citation endpoints. source_type describes the kind of site, content_type the kind of page. /citations/tags GET Get Owned vs Earned Share How citations split between domains the brand owns, competitor-owned domains and earned third-party coverage. /sources/owned-share

Searches

The web searches the AI platforms actually ran while answering a prompt.

GET Get Top Web Searches The searches AI models ran before answering this brand's prompts - the terms to rank for, as opposed to the pages already cited. /searches

Prompts

Per-prompt standings and the advice agent's guidance on improving them.

GET Get Prompt Leaderboard For ONE prompt: headline metrics plus every brand named on it, ranked. Requires brand_prompt_id from listQueries. /prompts/leaderboard GET List Prompts by Visibility Prompts ordered by visibility: ascending finds the gaps where the brand loses, descending finds the wins. /prompts/by-visibility GET Get Ranking Advice for a Prompt Completed ranking-advice runs for ONE prompt — what to change to rank better. Read-only: this never starts a new run. Requires brand_prompt_id from listQueries. /prompts/ranking-advice GET List Ranking Advice Runs Ranking-advice runs across ALL of a brand's prompts. Use this to find which prompts already have advice before calling getRankingAdvice. /ranking-advice

Answers

The raw AI answers behind every metric, in full.

GET List Sample AI Answers Recent AI answers for the brand's prompts, each with a short preview of the answer. To read one answer in full, take its run_id from this list and call getQueryRun. /query-runs GET Get One AI Answer in Full One run in full: the complete answer text, every brand mentioned, every source cited and every web search the AI ran. Use this after listQueryRuns when the preview isn't enough. /query-runs/{run_id}

Video

Summaries of cited YouTube videos the brand has paid to analyze.

GET List YouTube Summaries Cited YouTube videos this brand has already paid to summarize. /youtube/summaries GET Get YouTube Summary Summary, key points and optional transcript for one cited YouTube URL. /youtube/summary

Writes

Add brands and prompts to track. These need a write-enabled API key.

POST Add Tracked Brand Start tracking a new brand. Requires a write-enabled API key. /brands/tracked POST Add Prompts to Track Add prompts to track for a brand across the chosen AI platforms and queue the first crawl. Requires a write-enabled API key. /prompts