For developers and agents

friendly4AI provides a public API for scores and leaderboards, plus endpoints to run scans and fetch reports.

What friendly4AI does

friendly4AI analyzes websites to measure AI-readiness — how well AI systems (ChatGPT, Gemini, Claude, Grok, Perplexity, and AI crawlers) can understand and surface a content on website.

You can integrate friendly4AI into your agent workflows to (1) trigger a scan, (2) fetch a score, and (3) query the public Top Friendly4AI leaderboard.

Actions (high level)

Create a scan (guest/public)
Poll scan status (until completed/failed)
Get a site score by domain (public)
Get Top Friendly4AI leaderboard (public)

Public API (no authentication)

Create a guest scan: POST /api/public/reports
Fetch guest scan status/summary: GET /api/public/reports/{reportId}
Get site score by domain: GET /api/public/site-score?domain=example.com
Top Friendly4AI leaderboard: GET /api/public/top-friendly4ai?page=0&size=10

Request examples

curl -X POST "https://friendly4.ai/api/public/reports"   -H "Content-Type: application/json"   -d '{"url":"https://example.com"}'

curl "https://friendly4.ai/api/public/reports/<reportId}"

curl "https://friendly4.ai/api/public/site-score?domain=example.com"

curl "https://friendly4.ai/api/public/top-friendly4ai?page=0&size=10"

Response examples

POST /api/public/reports

{
  "id": "b4f7b307-7f8c-4495-9385-4bc84d0ee2f2",
  "url": "https://example.com",
  "reportType": "SIMPLE",
  "status": "QUEUED",
  "createdAt": "2026-02-15T18:23:41.160Z"
}

GET /api/public/reports/{reportId}

{
  "id": "b4f7b307-7f8c-4495-9385-4bc84d0ee2f2",
  "url": "https://example.com",
  "reportType": "SIMPLE",
  "status": "COMPLETED",
  "totalScore": 82,
  "processingStartedAt": "2026-02-15T18:23:43.021Z",
  "processingCompletedAt": "2026-02-15T18:24:04.311Z"
}

Processing, polling, and rate limits

Scans are processed asynchronously. Poll the status endpoint until the report reaches COMPLETED or FAILED.
If you get HTTP 429, respect the Retry-After header and retry later.
If a scan is blocked by robots.txt / site policy, you may receive a 403/404 depending on endpoint and context.

OpenAPI

Public OpenAPI JSON (canonical)Public OpenAPI JSON (compat)llms.txt (agent-friendly)

In production, dynamic OpenAPI endpoints may be disabled. Use the static OpenAPI JSON artifact above as the primary contract for agents and integrations.

Last updated: 2026-01-30