Documentation

Getting started

The AgentVeris public API lets you submit a scan and poll for results. No API key required for basic use.

POST https://api.agentveris.com/api/scans
Content-Type: application/json

{
  "url": "https://your-store.com"
}

# Response
{
  "id": "scan_abc123",
  "status": "pending",
  "url": "https://your-store.com"
}

GET https://api.agentveris.com/api/scans/{scan_id}

# Response (when completed)
{
  "id": "scan_abc123",
  "status": "completed",
  "url": "https://your-store.com",
  "overall_score": 74.5,
  "crawlability_score": 90.0,
  "schema_score": 85.0,
  "attributes_score": 70.0,
  "performance_score": 95.0,
  "ucp_score": 60.0,
  "acp_score": 30.0,
  "mcp_score": 50.0,
  "checks": [ ... ],
  "page_count": 8
}

# Submit scan
SCAN_ID=$(curl -s -X POST https://api.agentveris.com/api/scans \
  -H "Content-Type: application/json" \
  -d '{"url":"https://your-store.com"}' | jq -r '.id')

# Poll until completed
until curl -s "https://api.agentveris.com/api/scans/$SCAN_ID" | grep -q '"status":"completed"'; do
  sleep 3
done

# Get results
curl -s "https://api.agentveris.com/api/scans/$SCAN_ID" | jq '.overall_score'

Check result schema

Each item in the checks array has this shape:

{
  "check_name": "ucp_manifest_exists",
  "category": "ucp",          // crawlability | schema | attributes | performance | ucp | acp | mcp
  "status": "fail",           // pass | fail | warning | info
  "score": 0,                 // null for info checks
  "message": "No UCP manifest found at /.well-known/ucp",
  "details": { ... },         // optional structured data
  "url": "https://..."        // the URL checked (for multi-page checks)
}

Scoring reference

HTTP status codes