HomePrivacy

Scoreclaw API

Integrate AI agent readiness scoring into your workflow. Scan websites programmatically and get deterministic scores.

npx scoreclaw scan https://example.com

Start a Scan

Initialize a new AI readiness scan for any website URL.

POST/api/scan

Request

curl
curl -X POST https://scoreclaw.com/api/scan \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'
Request body
{
  "url": "https://example.com"
}

Response

200 Success
{
  "scanId": "scn_1234567890",
  "streamUrl": "/api/scan/scn_1234567890/stream"
}

Stream Scan Progress

Subscribe to real-time scan events via Server-Sent Events (SSE).

GET/api/scan/:id/stream

Request

curl
curl -N -H "Accept: text/event-stream" \
  https://scoreclaw.com/api/scan/scn_1234567890/stream

Event Types

status - Scan progress updates
endpoint - API endpoint discovery
category_score - Individual category scores
total - Final total score
paywall - Full report requires payment
done - Scan complete
Example events
event: status
data: {"message": "Scanning homepage..."}

event: endpoint
data: {"endpoint": "/api/products", "status": 200}

event: total
data: {"score": 73}

event: done
data: {}

Unlock Full Report

Create a Stripe checkout session to purchase the detailed report.

POST/api/scan/:id/unlock

Request

curl
curl -X POST \
  https://scoreclaw.com/api/scan/scn_1234567890/unlock

Response

200 Success
{
  "checkoutUrl": "https://checkout.stripe.com/c/pay/..."
}

Get Full Report

Retrieve the complete AI readiness report (requires payment).

GET/api/report/:id

Request

curl
curl https://scoreclaw.com/api/report/scn_1234567890

Response

200 Success
{
  "scanId": "scn_1234567890",
  "url": "https://example.com",
  "score": 73,
  "categories": {
    "discovery": {"score": 18, "max": 20},
    "content": {"score": 14, "max": 20},
    "structured": {"score": 22, "max": 30},
    "agent": {"score": 7, "max": 10},
    "security": {"score": 12, "max": 20}
  },
  "endpoints": [...],
  "report": "Detailed AI readiness analysis..."
}

Health Check

Verify API availability and status.

GET/api/health

Request

curl
curl https://scoreclaw.com/api/health

Response

200 Success
{
  "status": "healthy",
  "timestamp": "2026-02-24T10:30:00Z"
}