API Reference

Build on top of
RivalDesk.

A RESTful API for querying competitors, intelligence reports, battle cards, and alerts. Build custom integrations, power internal dashboards, and automate competitive workflows.

Quick Start
# List all tracked competitors
curl https://api.rivaldesk.com/v1/competitors \
  -H "Authorization: Bearer rd_live_..."

# Response
{
  "data": [
    {
      "id": "comp_8x7kQ2",
      "name": "Beacon AI",
      "status": "active",
      "last_signal": "2026-02-23T09:41:00Z"
    }
  ],
  "has_more": true
}
Authentication

Bearer token authentication

All API requests require a Bearer token in the Authorization header. API keys can be generated from your RivalDesk dashboard under Settings > API Keys.

Test and live keys
Sandbox keys (rd_test_) for development, live keys (rd_live_) for production.
Scoped permissions
Restrict keys to specific resources - read-only, write, or admin access.
Key rotation
Rotate keys without downtime. Old keys remain valid for 24 hours after rotation.
Authentication Example cURL
# Include your API key in the Authorization header
curl https://api.rivaldesk.com/v1/competitors \
  -H "Authorization: Bearer rd_live_sk_7f3a..." \
  -H "Content-Type: application/json"

# Test mode - use your test key
curl https://api.rivaldesk.com/v1/competitors \
  -H "Authorization: Bearer rd_test_sk_9b2c..."
Endpoints

Key API resources

Four core resources cover the full competitive intelligence workflow - from competitor tracking to actionable alerts.

Competitors
/v1/competitors

Manage your tracked competitors. Create, update, archive, and list competitors. Query monitoring status and last detected signals.

GET POST PUT DELETE
Intelligence Reports
/v1/reports

Access AI-generated intelligence reports. Filter by competitor, severity, source channel, and date range. Includes business impact analysis and recommended actions.

GET
Battle Cards
/v1/battle-cards

Retrieve auto-generated battle cards with pricing comparisons, strengths and weaknesses, objection handling, and win themes. Filterable by competitor.

GET PUT
Alerts
/v1/alerts

Manage alert rules and retrieve triggered alerts. Configure triggers by competitor, keyword, source, and severity. Supports webhook delivery for real-time notifications.

GET POST PUT DELETE
Example

Fetch the latest intelligence report

Query reports filtered by competitor and severity. The response includes AI-generated summaries, business impact analysis, and recommended next actions.

Pagination
Cursor-based pagination with configurable page size (default 20, max 100).
Filtering
Filter by competitor_id, severity, source, and date range using query parameters.
Response format
JSON responses with consistent structure. Errors include machine-readable codes and human-friendly messages.
Fetch Intelligence Reports Python
import requests

# Fetch critical reports for a specific competitor
response = requests.get(
    "https://api.rivaldesk.com/v1/reports",
    headers={
        "Authorization": "Bearer rd_live_sk_7f3a..."
    },
    params={
        "competitor_id": "comp_8x7kQ2",
        "severity": "critical",
        "limit": 5
    }
)

data = response.json()

for report in data["data"]:
    print(f"[{report['severity']}] {report['title']}")
    print(f"  Impact: {report['business_impact']}")
    print(f"  Action: {report['recommended_action']}")
    print()

# Output:
# [CRITICAL] Pricing restructured - free tier removed
#   Impact: Competitor losing SMB segment, doubling
#           down on enterprise positioning
#   Action: Update battle cards, brief sales on new
#           pricing objection handling
Rate Limits

Generous limits for production workloads

Rate limits are applied per API key. Responses include rate limit headers so you can monitor your usage in real time.

1,000
Requests per minute
Scale plan default. Burst up to 1,500 for short periods.
X-RateLimit-Limit
5,000
Requests per minute
Enterprise plan default. Custom limits available on request.
X-RateLimit-Limit
429
Rate limit exceeded
Retry-After header indicates seconds until the limit resets.
Retry-After: 30

Ready to build?

Explore the full API reference, generate your keys, and start building custom competitive intelligence workflows today.

API access included on Scale and Enterprise plans