Skip to main content
The Heralded API reads your brands’ figures, prompts, answers, competitors, sources and actions. It is read-only, and it doesn’t yet cover everything the app shows; the API reference lists what it serves. There are two ways in:
  • REST. GET routes under https://api.heralded.ai/v1, described in the API reference. Use them from scripts, notebooks and BI tools.
  • MCP. The Model Context Protocol is how AI assistants connect to tools. Heralded runs an MCP server at https://api.heralded.ai/v1/mcp with one tool per route, for AI assistants and agents. An assistant can sign in or use a key.
Both read as the member who holds the credential, in one organization, which is what Core and Plus call a workspace. Neither can change anything.

​
Quickstart

1

Create an API key

In Heralded, open Settings, choose You, then API keys, and create a key. Copy it now. It starts with hrld_, and Heralded never shows it again. See API keys.
2

List your brands

3

Read a brand's overview

The overview holds all five figures over your selected period, defaulting to 1w, with a descriptor of its report count, answer dates and excluded reports. Change compares the period with the preceding reports, as many as the period holds and at least four when available. It also holds the latest report’s status line and citation metrics, top competitors, most cited sources, newest open actions, the next weekly and daily scan times, the daily scans since the last weekly report, the open action count and the readiness counts. Figures in the API describes the periods and fields.

​
Every plan

The API and the MCP server are included on every plan, and no plan limits what they read. Each key has a rate limit.