REST API

Conventions

• Base URL https://herculeradar.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://herculeradar.com/docs/reference/list_mentions"
  }
}