{ "openapi": "3.0.1", "info": { "title": "AI Search Readiness Audit - llms.txt, AI Bots & Schema", "description": "Is your site visible to ChatGPT, Perplexity and Claude? Score it 0-100: robots.txt rules for GPTBot, ClaudeBot, PerplexityBot; llms.txt; JSON-LD; sitemap; text in raw HTML. Get a prioritized fix list plus a ready llms.txt, robots snippet and recommended JSON-LD.", "version": "2.0", "x-build-id": "3IeHKzfU1mbYiKShp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~ai-search-readiness-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-ai-search-readiness-audit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/that_red_bird~ai-search-readiness-audit/runs": { "post": { "operationId": "runs-sync-that_red_bird-ai-search-readiness-audit", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/that_red_bird~ai-search-readiness-audit/run-sync": { "post": { "operationId": "run-sync-that_red_bird-ai-search-readiness-audit", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "siteUrl": { "title": "Site URL", "type": "string", "description": "The site to score, e.g. https://example.com. Pages come from its sitemap.xml (also those named in robots.txt) or from following same-origin links. The exact URL you type is always audited, so you can also paste a single page.", "default": "https://docs.apify.com" }, "mode": { "title": "Mode", "enum": [ "full", "llms-txt", "json-ld" ], "type": "string", "description": "full: score 0-100 across six areas with a prioritized fix list, plus all generated files. llms-txt: only generate and check llms.txt. json-ld: only structured data, per-page JSON-LD check and a recommended block for pages that have none.", "default": "full" }, "maxPages": { "title": "Max pages to audit", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many pages are fetched and checked. Page-level scores are measured on this sample, so raise it for large sites. Site-level checks (robots.txt, sitemap, llms.txt) always cover the whole site.", "default": 20 }, "useSitemap": { "title": "Use sitemap.xml", "type": "boolean", "description": "Pick pages from the sitemap first. Falls back to following links from the start URL when there is none.", "default": true }, "includePatterns": { "title": "Only URLs containing", "type": "array", "description": "Audit only URLs containing one of these substrings, e.g. /docs/, /blog/. Empty means all.", "default": [], "items": { "type": "string" } }, "excludePatterns": { "title": "Skip URLs containing", "type": "array", "description": "Skip URLs containing any of these substrings, e.g. /tag/, /author/.", "default": [], "items": { "type": "string" } }, "testBotAccess": { "title": "Test whether the server serves AI crawlers", "type": "boolean", "description": "Request your homepage with the User-Agent of OAI-SearchBot, PerplexityBot, Claude-SearchBot, GPTBot and ClaudeBot and compare with a normal browser, to catch WAF or CDN rules that return 403/429 to them. It only changes the User-Agent header; real crawlers come from published IP ranges, so treat a pass as likely, not proof.", "default": true }, "generateFullText": { "title": "Also generate llms-full.txt", "type": "boolean", "description": "Besides llms.txt, build llms-full.txt: the markdown of every audited page in one file, capped by the size limit below. Needs more time on big sites.", "default": false }, "maxFullTextChars": { "title": "llms-full.txt size limit (characters)", "minimum": 10000, "maximum": 5000000, "type": "integer", "description": "Stop adding pages to llms-full.txt after this many characters.", "default": 500000 }, "siteName": { "title": "Site name for llms.txt", "type": "string", "description": "Overrides the name used as the H1 of the generated llms.txt. Empty means it is taken from the first page title.", "default": "" }, "summary": { "title": "Summary for llms.txt", "type": "string", "description": "Overrides the one-sentence blockquote summary of the generated llms.txt. Empty means the meta description of the first page that has one.", "default": "" }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages are fetched in parallel.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional Apify proxy for sites that block datacenter IPs. Off by default.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }