API Documentation

All API requests require a Bearer token. Obtain your token by signing in via the ScoreCraft dashboard — the same Auth0 token used by the web app works for API calls.

Authorization: Bearer YOUR_ACCESS_TOKEN

Tokens expire after 1 hour. Use the Auth0 SDK's silent refresh to obtain new tokens automatically.

https://scorecraft.ai/api

Start a new website audit. Returns the audit ID for polling.

Request Body

{
  "primary_url": "https://example.com",
  "competitor_url": "https://competitor.com",  // optional
  "force": false                                // true to bypass cache
}

Response

{
  "audit_id": "a1b2c3d4e5f6...",
  "status": "pending",
  "cached": false
}

Check the status of a running audit. Poll until status is complete or failed.

Response

{
  "status": "complete",
  "growth_score": 72,
  "sub_scores": {
    "technical": 22,
    "seo": 24,
    "monetization": 18,
    "clarity": 8
  },
  "primary_url": "https://example.com",
  "completed_at": "2026-03-22T10:30:00Z"
}

Retrieve your audit history, profile data, and usage stats.

Response

{
  "profile": {
    "plan": "pro",
    "audits_this_month": 5,
    "audit_limit": null
  },
  "audits": [
    {
      "id": "a1b2c3...",
      "primary_url": "https://example.com",
      "growth_score": 72,
      "status": "complete",
      "created_at": "2026-03-22 10:00:00"
    }
  ]
}

Get your current profile, plan, and usage information.

Generate or toggle a shareable public link for an audit report.

Request Body

{
  "audit_id": "a1b2c3...",
  "enabled": true
}

List your active score monitors. Requires Starter or Pro plan.

Create a new score monitor for a URL.

Request Body

{
  "url": "https://example.com",
  "frequency": "weekly",
  "alert_email": "you@example.com",
  "alert_threshold": 5
}