ToolYourToolYourAPI Docs

AI Overview readiness checker (structural heuristics)

GET
/api/v1/seo-apis/ai-overview-readiness-checker

Authorization

ApiKeyAuth
X-Api-Key<token>

API key created via POST /api/v1/api-keys (shown once at creation)

In: header

Query Parameters

url*string
format?string

Optional export mode. Omit for the standard JSON envelope. markdown returns text/markdown assembled from scores + findings (agent brief template, not AI prose). json returns pretty-printed toolResult JSON without the envelope wrapper.

Value in

  • "markdown"
  • "json"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/seo-apis/ai-overview-readiness-checker?url=string"
{  "status": true,  "code": 200,  "message": "Success",  "result": {},  "warnings": [    "string"  ],  "error": "string"}
{  "message": "string",  "detail": "string",  "status": false,  "code": 0,  "error": "string"}
Empty
{  "message": "string",  "detail": "string",  "status": false,  "code": 0,  "error": "string"}
Empty
Empty