{ "openapi": "3.1.0", "info": { "title": "AIScan Agent API", "version": "5.9.0", "description": "AI visibility auditing for websites, pay-per-capability via x402 on Base. 4 score types: AEO (AI Search Visibility), GEO (Citation Readiness), Agent Readiness, and MCP Readiness - the only scanner that checks MCP. Plus brand visibility measurement: how often AI assistants actually mention your brand.", "x-guidance": "Start with GET /api/agent/index (free) to see all 18 capabilities and prices. Cheap checks (check_health, check_llms_txt, check_schema, check_mcp, 0.06-0.08 USDC) are pure HTTP checks. Scores (score_aeo/geo/agent/mcp, 0.15-0.20 USDC) return a 0-100 score with detailed checks. full_audit (0.35) returns all 4 scores. fix_pack (0.55) returns copy-paste fixes for failed checks. compare (0.80) needs both url and competitor in the JSON body. full_report (1.55) bundles everything. visibility_check (1.95) measures how often AI assistants mention a brand across 30 realistic niche prompts - needs brand and niche in the JSON body, no url. visibility_vs_competitor (3.50) measures two brands head-to-head on the same 30 prompts - needs brand, competitor_brand and niche. visibility_fix_pack (1.25) generates ready-to-deploy fix materials (citable passages, FAQ schema, llms.txt sections) - needs brand, niche and weak_spots array from a prior visibility_check; the weak_spots field is included in every visibility_check response. All paid routes accept POST with JSON body and x402 payment: either a signed PAYMENT-SIGNATURE payload (settled via Coinbase CDP facilitator) or a Base USDC transfer tx hash in the same header (direct-transfer).", "contact": { "url": "https://getaiscan.app" } }, "servers": [ { "url": "https://api.getaiscan.app" } ], "components": { "securitySchemes": { "x402": { "type": "apiKey", "in": "header", "name": "PAYMENT-SIGNATURE", "description": "x402 V2 payment: signed payload or Base USDC tx hash" } } }, "paths": { "/api/agent/check_health": { "post": { "operationId": "check_health", "summary": "Site availability, robots.txt, AI crawler access (GPTBot, ClaudeBot, PerplexityBot), sitemap presence", "tags": [ "AI Visibility" ], "description": "Site availability, robots.txt, AI crawler access (GPTBot, ClaudeBot, PerplexityBot), sitemap presence. Pay 0.06 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.060000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/check_llms_txt": { "post": { "operationId": "check_llms_txt", "summary": "llms.txt existence and quality check: sections, links, statistics", "tags": [ "AI Visibility" ], "description": "llms.txt existence and quality check: sections, links, statistics. Pay 0.07 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.070000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/check_schema": { "post": { "operationId": "check_schema", "summary": "Schema.org JSON-LD detection: types found, FAQ schema, Organization schema", "tags": [ "AI Visibility" ], "description": "Schema.org JSON-LD detection: types found, FAQ schema, Organization schema. Pay 0.07 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.070000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/check_agent_files": { "post": { "operationId": "check_agent_files", "summary": "openapi.json, ai-plugin.json, x402 payment support detection", "tags": [ "AI Visibility" ], "description": "openapi.json, ai-plugin.json, x402 payment support detection. Pay 0.07 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.070000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/check_mcp": { "post": { "operationId": "check_mcp", "summary": "MCP discoverability: /.well-known/mcp.json, agent.json, MCP Server Card", "tags": [ "AI Visibility" ], "description": "MCP discoverability: /.well-known/mcp.json, agent.json, MCP Server Card. Pay 0.08 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.080000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/score_aeo": { "post": { "operationId": "score_aeo", "summary": "Full AEO (AI Search Visibility) score 0-100 with detailed checks", "tags": [ "AI Visibility" ], "description": "Full AEO (AI Search Visibility) score 0-100 with detailed checks. Pay 0.15 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.150000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/score_geo": { "post": { "operationId": "score_geo", "summary": "Full GEO (Citation Readiness) score 0-100 with detailed checks", "tags": [ "AI Visibility" ], "description": "Full GEO (Citation Readiness) score 0-100 with detailed checks. Pay 0.15 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.150000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/score_agent": { "post": { "operationId": "score_agent", "summary": "Full Agent Readiness score 0-100 with detailed checks", "tags": [ "AI Visibility" ], "description": "Full Agent Readiness score 0-100 with detailed checks. Pay 0.15 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.150000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/score_mcp": { "post": { "operationId": "score_mcp", "summary": "Full MCP Readiness score 0-100, the only scanner that checks this", "tags": [ "AI Visibility" ], "description": "Full MCP Readiness score 0-100, the only scanner that checks this. Pay 0.2 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.200000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/full_audit": { "post": { "operationId": "full_audit", "summary": "Complete audit: all 4 scores (AEO, GEO, Agent, MCP), 80+ checks", "tags": [ "AI Visibility" ], "description": "Complete audit: all 4 scores (AEO, GEO, Agent, MCP), 80+ checks. Pay 0.35 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.350000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/generate_llms_txt": { "post": { "operationId": "generate_llms_txt", "summary": "Generate a ready-to-deploy llms.txt tailored to the site", "tags": [ "AI Visibility" ], "description": "Generate a ready-to-deploy llms.txt tailored to the site. Pay 0.3 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.300000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/generate_mcp_json": { "post": { "operationId": "generate_mcp_json", "summary": "Generate ready-to-deploy mcp.json + agent.json for the site", "tags": [ "AI Visibility" ], "description": "Generate ready-to-deploy mcp.json + agent.json for the site. Pay 0.3 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.300000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/fix_pack": { "post": { "operationId": "fix_pack", "summary": "Copy-paste fix instructions for every failed check", "tags": [ "AI Visibility" ], "description": "Copy-paste fix instructions for every failed check. Pay 0.55 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.550000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/compare": { "post": { "operationId": "compare", "summary": "Gap analysis vs a competitor URL: who wins each category and why", "tags": [ "AI Visibility" ], "description": "Gap analysis vs a competitor URL: who wins each category and why. Pay 0.8 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "0.800000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" }, "competitor": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the competitor website to compare against" } }, "required": [ "url", "competitor" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/full_report": { "post": { "operationId": "full_report", "summary": "Everything: full audit + fix pack + generated llms.txt and mcp.json", "tags": [ "AI Visibility" ], "description": "Everything: full audit + fix pack + generated llms.txt and mcp.json. Pay 1.55 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "1.550000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "minLength": 1, "description": "Full URL of the website to analyze, e.g. https://example.com" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/visibility_check": { "post": { "operationId": "visibility_check", "summary": "Brand visibility in AI answers: 30 realistic niche prompts answered by Claude, mention rate, share of voice, who gets recommended instead. Params: brand + niche (no url needed)", "tags": [ "AI Visibility" ], "description": "Brand visibility in AI answers: 30 realistic niche prompts answered by Claude, mention rate, share of voice, who gets recommended instead. Params: brand + niche (no url needed). Pay 1.95 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "1.950000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "type": "string", "minLength": 1, "description": "Brand name to measure, e.g. \"Notion\"" }, "niche": { "type": "string", "minLength": 1, "description": "Market niche or category, e.g. \"project management software\"" } }, "required": [ "brand", "niche" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/visibility_vs_competitor": { "post": { "operationId": "visibility_vs_competitor", "summary": "Head-to-head brand visibility in AI answers: 30 niche prompts, both brands measured on the same answers - mention rates, share of voice, verdict. Params: brand + competitor_brand + niche (no url needed)", "tags": [ "AI Visibility" ], "description": "Head-to-head brand visibility in AI answers: 30 niche prompts, both brands measured on the same answers - mention rates, share of voice, verdict. Params: brand + competitor_brand + niche (no url needed). Pay 3.5 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "3.500000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "type": "string", "minLength": 1, "description": "Brand name to measure, e.g. \"Notion\"" }, "niche": { "type": "string", "minLength": 1, "description": "Market niche or category, e.g. \"project management software\"" }, "competitor_brand": { "type": "string", "minLength": 1, "description": "Competitor brand name to compare against, e.g. \"Asana\"" } }, "required": [ "brand", "niche", "competitor_brand" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/visibility_fix_pack": { "post": { "operationId": "visibility_fix_pack", "summary": "Ready-to-deploy fix materials for weak visibility areas: citable passages, FAQ schema JSON-LD, llms.txt sections. Params: brand + niche + weak_spots array (from a prior visibility_check)", "tags": [ "AI Visibility" ], "description": "Ready-to-deploy fix materials for weak visibility areas: citable passages, FAQ schema JSON-LD, llms.txt sections. Params: brand + niche + weak_spots array (from a prior visibility_check). Pay 1.25 USDC via x402 on Base (eip155:8453).", "x-payment-info": { "price": { "mode": "fixed", "currency": "USD", "amount": "1.250000" }, "protocols": [ { "x402": {} } ] }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "type": "string", "minLength": 1, "description": "Brand name to measure, e.g. \"Notion\"" }, "niche": { "type": "string", "minLength": 1, "description": "Market niche or category, e.g. \"project management software\"" }, "weak_spots": { "type": "array", "minItems": 1, "maxItems": 3, "description": "Weak areas from a prior visibility_check analysis", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "who_wins": { "type": "string" }, "evidence": { "type": "string" } }, "required": [ "topic" ] } } }, "required": [ "brand", "niche", "weak_spots" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "string", "description": "Capability that was executed" }, "url": { "type": "string", "description": "Analyzed site URL" }, "payment": { "type": "object", "description": "Payment settlement info" } }, "required": [ "capability" ] } } } }, "402": { "description": "Payment Required" } } } }, "/api/agent/index": { "get": { "operationId": "index", "summary": "Free capability catalog with prices and endpoints", "security": [], "responses": { "200": { "description": "Catalog of all capabilities", "content": { "application/json": { "schema": { "type": "object", "properties": { "capabilities": { "type": "object" } }, "required": [ "capabilities" ] } } } } } } } } }