REST API

15 capabilities. Each one is also an MCP tool of the same name.

Conventions

  • Base URL https://herculradar.com/api/v1, JSON in and out, ISO 8601 UTC timestamps.
  • Every success returns { data, meta }; every failure returns { error }.
  • meta.requestId is echoed in the x-request-id header — quote it in support.
  • meta.docs links to the page for that exact capability.
  • An API key is scoped to one project, so no endpoint takes a project id.
  • Lists page by cursor, never by offset.
  • Writes accept Idempotency-Key; retries replay rather than duplicate.

Envelope

{
  "data": { "…": "the resource" },
  "meta": {
    "capability": "list_mentions",
    "requestId": "req_9f2b4a8c1d0e",
    "idempotencyReplayed": false,
    "docs": "https://herculradar.com/docs/reference/list_mentions"
  }
}

Projects

A workspace holding monitors, mentions and alerts.

Monitors

A keyword set watched across one or more sources.

Mentions

A collected public post with its AI classification.

Alerts

A rule that pushes matching mentions to email or a webhook.

Usage

Quota consumption and measured provider cost.