Agentic Store Score developer docs
Official documentation for the public API, OpenAPI contract, structured errors, and rate limits.
Pricing
Agentic Store Score is free to use. There are no paid plans, subscription charges, or per-report fees. The public website and read-only API are available without payment.
Command line
Run a scan from any recent Node.js installation. The CLI submits the store, waits for the worker, and prints the score and public report URL.
npx is-agentic-store https://yourstore.comAdd --json for the complete machine-readable report or --no-wait to return immediately after queueing the scan.
Public report API
Retrieve the latest completed Agentic Store Score report for a public store URL. The response includes the score, category breakdown, sampled products, evidence-backed issues, and the canonical browser report URL. This read-only endpoint does not launch a scan.
Read the complete request and response schema in the OpenAPI description.
Start a scan
POST to /api/scan with a JSON body containing a url field. Returns a scan ID that can be polled at /api/scan/{id} until the status is completed.
Errors
API errors return a human-readable error message and an appropriate HTTP status. Rate-limit responses also include Retry-After.
- 400 Invalid URL
- Pass a public HTTP or HTTPS URL.
- 404 Scan not found
- No completed scan exists for this domain. Start one from the homepage.
- 429 Rate limit exceeded
- Honor the Retry-After header before retrying.
Rate limits
The scan API allows 5 requests per client IP in each 60-second window. A 429 response includes a Retry-After header. The read-only report API is cacheable; production deployments should apply an edge-level read quota.
Authentication
The documented API is public and requires no API key or OAuth flow. POST requests may queue public storefront scans; report lookups are read-only. The API exposes no credentials, webhooks, or event subscriptions.