{
  "openapi": "3.1.0",
  "info": {
    "title": "CrawlReadable API",
    "version": "1.0.0",
    "description": "Score how readable a website is to AI crawlers that don't run JavaScript."
  },
  "servers": [
    {
      "url": "https://crawlreadable.com"
    }
  ],
  "paths": {
    "/api/audit": {
      "get": {
        "operationId": "auditSite",
        "summary": "Score a website for AI readability",
        "description": "Fetches the site's homepage, robots.txt, llms.txt and sitemap.xml without JavaScript and returns a 0-100 score, per-check results and ranked fixes. Rate limited to 10 requests per minute per IP.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "Domain or URL, e.g. example.com",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Audit report. score and grade are null when the site could not be scored (see error).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "domain": {
                      "type": "string"
                    },
                    "score": {
                      "type": [
                        "integer",
                        "null"
                      ]
                    },
                    "grade": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "reachable": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "permalink": {
                      "type": "string"
                    },
                    "checks": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "category": {
                            "type": "string"
                          },
                          "points": {
                            "type": "integer"
                          },
                          "passed": {
                            "type": "boolean"
                          }
                        }
                      }
                    },
                    "fixes": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "check": {
                            "type": "string"
                          },
                          "points_lost": {
                            "type": "integer"
                          },
                          "fix": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Missing url parameter"
          },
          "429": {
            "description": "Rate limit reached"
          }
        }
      }
    }
  }
}