# Heralded

- [Heralded documentation](https://docs.heralded.ai/index.md): How Heralded measures your brand in AI answers, what every figure means, and how to use the app and the API.
- [Get started](https://docs.heralded.ai/get-started.md): Set up your first brand, read your first report, and know what to do in your first week.
- [Your first weekly report](https://docs.heralded.ai/first-weekly-report.md): What changes a week after setup, and where to look first.
- [How Heralded works](https://docs.heralded.ai/how-heralded-works.md): The loop behind the Command Center: ask what your buyers ask, measure the answers, act, and check it worked.
- [Snapshot](https://docs.heralded.ai/concepts/snapshot.md): The one-off report on one brand: what it asks, what it shows, and how it carries into the Command Center.
- [Leaderboards](https://docs.heralded.ai/concepts/leaderboards.md): How published monthly visibility measurements are filtered and compared.
- [Prompts](https://docs.heralded.ai/concepts/prompts.md): The buyer questions Heralded asks every engine, and how to choose them.
- [Engines](https://docs.heralded.ai/concepts/engines.md): The AI engines Heralded asks, and how each one is treated.
- [Daily updates and weekly reports](https://docs.heralded.ai/concepts/daily-updates-and-weekly-reports.md): When Heralded asks the engines, and when your figures change.
- [Competitors](https://docs.heralded.ai/concepts/competitors.md): The competitors you track, the brands AI names in your answers, and how you rank.
- [Sources](https://docs.heralded.ai/concepts/sources.md): Every site and page AI engines cite, whoever owns it.
- [Content](https://docs.heralded.ai/concepts/content.md): Topics your buyers ask about, your page for each, and what to do next.
- [Can AI read your site?](https://docs.heralded.ai/concepts/site-readability.md): What stops AI engines reading the pages that matter, and how Heralded checks it.
- [Segments](https://docs.heralded.ai/concepts/segments.md): Measure the same brand in another market, language or buyer's voice.
- [Actions](https://docs.heralded.ai/concepts/actions.md): The work that changes what AI says about you, who holds it, and how you know it paid off.
- [Autonomy](https://docs.heralded.ai/concepts/autonomy.md): Decide how much Heralded does without asking you first.
- [Workspaces and brands](https://docs.heralded.ai/concepts/workspaces-and-brands.md): Where your brands live, who can see them, and what each role can do.
- [Connections](https://docs.heralded.ai/concepts/connections.md): What each connection does, what it reads and writes, how to connect it and what removing it leaves.
- [Connect Cloudflare](https://docs.heralded.ai/connect-cloudflare.md): Count AI crawler requests that Cloudflare serves, caches or blocks.
- [Connect an AI assistant](https://docs.heralded.ai/assistants.md): Connect Claude, ChatGPT, Cursor, VS Code or Claude Code to Heralded by signing in. No key to copy.
- [Plans, trials and limits](https://docs.heralded.ai/concepts/usage.md): What counts against your plan, and how trials and content credits work.
- [Glossary](https://docs.heralded.ai/glossary.md): Every term Heralded uses, in a line or two, with a link to where it is explained.
- [How Heralded measures](https://docs.heralded.ai/methodology/how-we-measure.md): What an answer is, how each one is read, and which answers count toward your figures.
- [Mentioned and Recommended](https://docs.heralded.ai/methodology/mentioned-and-recommended.md): The two shares the Heralded Score is built from.
- [The Heralded Score](https://docs.heralded.ai/methodology/heralded-score.md): How the score is built from your answers, why it is calibrated, and how the scale was measured.
- [Ranges](https://docs.heralded.ai/methodology/ranges.md): What the 95% range around a figure means, and why it is sometimes wide.
- [Change](https://docs.heralded.ai/methodology/change.md): How Heralded decides whether a figure really moved.
- [Share of voice](https://docs.heralded.ai/methodology/share-of-voice.md): How brand names fill the share-of-voice chart on Competitors.
- [Perception](https://docs.heralded.ai/methodology/how-ai-describes-you.md): Understood and Praised: what the engines say about your brand when they name it.
- [Verifying actions](https://docs.heralded.ai/methodology/verifying-actions.md): How Heralded judges whether finished work changed the answers.
- [When a figure is empty](https://docs.heralded.ai/methodology/empty-figures.md): Why a figure can show nothing, and what fills it.
- [Heralded API](https://docs.heralded.ai/developers.md): Read your brands' AI visibility from a script, a spreadsheet or an AI assistant.
- [API keys](https://docs.heralded.ai/api-keys.md): Create, use and revoke the keys that read the Heralded API.
- [Connect an MCP client](https://docs.heralded.ai/connect-mcp.md): Give an AI assistant or agent read access to Heralded with an API key.
- [Figures in the API](https://docs.heralded.ai/figures.md): What each figure, state and enum value in the API means, and where the method behind it is explained.
- [Errors and limits](https://docs.heralded.ai/errors-and-limits.md): What each error means, and how many requests a key may make.
- [Versioning](https://docs.heralded.ai/versioning.md): What can change in the API within v1, and how score versions work.
- [API changelog](https://docs.heralded.ai/changelog.md): Every addition to the v1 API, newest first.
- [Get Brands](https://docs.heralded.ai/api-reference/v1/get-brands.md): The brands the token's issuer reads in its organization.
- [Get Overview](https://docs.heralded.ai/api-reference/v1/get-overview.md): A brand's figures over the selected period with ranges, states and change, the score's band, the latest report's status line and citation metrics, the top five rivals, the five most cited sources and the five newest open actions, the next weekly and daily scan times, the daily scans since the last w…
- [Get Scores](https://docs.heralded.ai/api-reference/v1/get-scores.md): All five figures over the selected period, with ranges, states, change and trends, over the answers the engine, type, intent, topic, segment and prompt filters keep, and per group under `group_by`. `include` also returns the Engines table or pane.
- [Get Perception](https://docs.heralded.ai/api-reference/v1/get-perception.md): The statement, positioning, claims, negative prompts and sources, and best quotes.
- [Get Perception Claim](https://docs.heralded.ai/api-reference/v1/get-perception-claim.md): One claim's verdicts, quotes, contradicting prompts, engines and pages.
- [Get Prompts](https://docs.heralded.ai/api-reference/v1/get-prompts.md): The tracked prompts and how each engine's latest answer treated the brand.
- [Get Prompt](https://docs.heralded.ai/api-reference/v1/get-prompt.md): One prompt's period score and trend, latest answers, competitors and top sources.
- [Get Answers](https://docs.heralded.ai/api-reference/v1/get-answers.md): The engines' answers, newest first, optionally for one prompt, engine or named brand.
- [Get Answer](https://docs.heralded.ai/api-reference/v1/get-answer.md): One answer in full, with the pages it cited and the rivals it named.
- [Get Competitors](https://docs.heralded.ai/api-reference/v1/get-competitors.md): The brand and its tracked rivals, ranked by Heralded Score over the period.
- [Get Sources](https://docs.heralded.ai/api-reference/v1/get-sources.md): The domains the engines cited over the selected period, daily answers included.
- [Get Source](https://docs.heralded.ai/api-reference/v1/get-source.md): One cited site's facts, pages, prompts, engines and citation history under shared filters.
- [Get Cited Pages](https://docs.heralded.ai/api-reference/v1/get-cited-pages.md): Cited page rows under the period and shared filters, including engine.
- [Get Cited Page](https://docs.heralded.ai/api-reference/v1/get-cited-page.md): One cited page under the period and shared filters, daily answers included.
- [Get Changes](https://docs.heralded.ai/api-reference/v1/get-changes.md): Home's changes since the latest weekly scan, newest first, including new competitors.
- [Get Prompt Suggestions](https://docs.heralded.ai/api-reference/v1/get-prompt-suggestions.md): Discover's ranked recommendations with provenance, form and demand.
- [Get Pages](https://docs.heralded.ai/api-reference/v1/get-pages.md): The brand's own pages, most cited over the period first, with their citations, Visits from AI, AI crawler hits and the stored rubric.
- [Get Page](https://docs.heralded.ai/api-reference/v1/get-page.md): One of the brand's own pages over the period: its citations and the prompts and answers that cite it, its weekly trend, the stored rubric with each pillar, AI crawler hits by bot and Visits from AI by assistant. The funnel joins search, crawl, citation and visit measurements on the newest pinned wee…
- [Get Topics](https://docs.heralded.ai/api-reference/v1/get-topics.md): The topics buyers ask about from the latest scan's content pass in the period, each with the brand's page for it and its status, most demand first.
- [Get Topic](https://docs.heralded.ai/api-reference/v1/get-topic.md): One topic: its page, the questions it expands into, its prompts and the pages they cite most. Take the id from topics, URL-encoded.
- [Get Audit](https://docs.heralded.ai/api-reference/v1/get-audit.md): The latest crawl's readiness, site checks by group and pages.
- [Get Actions](https://docs.heralded.ai/api-reference/v1/get-actions.md): Proposed actions (group new) come in the brand's order, first priority first; other groups newest first.
- [List Conversations](https://docs.heralded.ai/api-reference/v1/list-conversations.md): Standing threads, shared chats and your own private chats, including archived chats. Unread counts use your read position. Owners and admins cannot read others' private chats.
- [Get Conversation By Id](https://docs.heralded.ai/api-reference/v1/get-conversation-by-id.md): One visible conversation's messages in sequence order, starting after your read position. Page with before or after sequence numbers, exclusively. Reading leaves your position unchanged. Posting and confirming stay in the app. A hidden conversation returns 404.
- [Get Conversation](https://docs.heralded.ai/api-reference/v1/get-conversation.md): The shared conversation with the Writer, Publicist or Engineer, oldest first within the newest page. Filter by task_id or page backwards with before. Unread counts belong to the token's issuer and cover the whole conversation. Reading never marks messages seen. Posting and suggestion clicks stay in…
- [Get Brand Settings](https://docs.heralded.ai/api-reference/v1/get-brand-settings.md): Current profile, rivals, owned domains, autonomy, connection status and segments.
- [Get Brand Segments](https://docs.heralded.ai/api-reference/v1/get-brand-segments.md): Segment configuration and the complete 1w comparison, sorted with Default first.
- [Get Organization Usage](https://docs.heralded.ai/api-reference/v1/get-organization-usage.md): Prompt use against the pool and content-credit use, for organization members.
- [Get Organization Brands](https://docs.heralded.ai/api-reference/v1/get-organization-brands.md): Portfolio rows with 1w figures, paired change and actions waiting.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.