For developers and agents

What friendly4AI does

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

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

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"

http POST "https://friendly4.ai/api/public/reports" url="https://example.com"

http GET "https://friendly4.ai/api/public/reports/<reportId>"

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

http GET "https://friendly4.ai/api/public/top-friendly4ai" page==0 size==10

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

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