Agentic Storefront Audit API
Integrate our agentic readiness engine directly into your platform. Programmatically trigger audits, retrieve scores, and identify prioritized fixes to make any storefront better prepared for AI agents and crawlers.
Synchronous Analysis
Trigger deep-scans and receive a full report in a single HTTP response.
Global Readiness
Access the same 178+ checks used by our web interface for consistent scoring.
Authentication
Authentication is handled via a Bearer token. You can generate and manage your API keys in the Settings dashboard.
Authorization: Bearer ucp_live_.../v1/analyze
Triggers a synchronous audit for a public URL. The scanner evaluates the site's readiness for AI agents across 10 categories.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| url | string | Yes | The full target URL (e.g., https://example.com) |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| summaryOnly | boolean | If true, returns only the pragmatic scan summary instead of the full report. |
| priority | string | Filter results by priority (critical, high, medium, low). |
Example Request
curl -X POST "https://audit.agenticstorefront.com/api/v1/analyze?priority=critical" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'/v1/audits
Returns dynamic catalog of all readiness checks currently available in our engine.
{
"audits": [
{
"id": "has-json-ld",
"category": "structured-data",
"name": "Has JSON-LD Schema",
"description": "Detects schema markup on the page."
},
...
],
"totalCount": 178
}Rate Limits & Quota
Maximum API calls per minute per API key.
The total number of scans allowed per month depends on your active plan.