API v1

Competitor battlecard

Cited per-competitor sales battlecard: Why We Win, Their Weaknesses, Objection Handlers, Discovery Questions. Every claim carries citations resolving to collected sources; claims that could not be cited were withheld. source is "generated" (the dashboard Battlecard tab) or "report" (the battlecard section of the competitor's latest report, with report_id and report_date, used when none was generated). status is read off the card's four sections: "ready" when every section carries a cited claim, "partial" when some do not, "withheld" when none does (withheld_reason says why); sections_empty names the sections with no claim, and sections_locked the ones among them that are locked until the user's company profile is complete (a generated card's Why We Win) rather than withheld. status: "not_generated" when no card can be served: none was generated, and the latest report either has no card for this competitor or has one in an older format that fails the citation contract (withheld from serving, never repaired). Pro plan required. Pass ?format=md for agent-ready Markdown.

get/api/v1/competitors/{id}/battlecard

Request

  • Base URL: https://api.rivalize.ai
  • URL: https://api.rivalize.ai/api/v1/competitors/{id}/battlecard
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

format'json' | 'md'

md returns text/markdown for direct agent consumption

Response

Success. status is "ready" (every section carries a cited claim), "partial" (sections_empty names the empty ones), "withheld" (no section carries a claim; withheld_reason says why) or "not_generated" (no card can be served).

Changes

No recorded changes to this operation across all 1 revision of this API.