{ "openapi": "3.0.1", "info": { "title": "AI Crawler Access Auditor", "description": "See whether your site's rules block ChatGPT, Perplexity, Claude, Google AI or Apple crawlers. Reads robots.txt per RFC 9309 and page noindex/X-Robots-Tag rules, runs a simulated crawler firewall test (a warning signal, not proof of real-crawler access), and gives copy-paste fixes. No API key needed.", "version": "0.1", "x-build-id": "uKjaIbzRQU0COQpOi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steadfeed~ai-crawler-access-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steadfeed-ai-crawler-access-auditor", "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/steadfeed~ai-crawler-access-auditor/runs": { "post": { "operationId": "runs-sync-steadfeed-ai-crawler-access-auditor", "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/steadfeed~ai-crawler-access-auditor/run-sync": { "post": { "operationId": "run-sync-steadfeed-ai-crawler-access-auditor", "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": { "urls": { "title": "Websites", "type": "array", "description": "Website addresses to audit, e.g. example.com or https://www.example.com/pricing. Up to 25 per run, checked one at a time. If you give a page address, that page is audited plus the homepage.", "default": [ "https://apify.com" ], "items": { "type": "string" } }, "extraPaths": { "title": "Extra pages to check", "type": "array", "description": "Up to 4 more paths on each site, e.g. /pricing or /blog/. Each is checked against robots.txt and for noindex tags.", "default": [], "items": { "type": "string" } }, "liveChecks": { "title": "Test with bot-like requests", "type": "boolean", "description": "Send one polite request per crawler (homepage only) using that crawler's name and compare the answer with a normal browser request. Shows firewall or bot-protection blocks as signals. Skipped for crawlers your robots.txt blocks.", "default": true }, "crawlers": { "title": "Crawlers to check", "type": "array", "description": "Leave empty to check all of them.", "items": { "type": "string", "enum": [ "OAI-SearchBot", "ChatGPT-User", "GPTBot", "PerplexityBot", "Perplexity-User", "Claude-SearchBot", "Claude-User", "ClaudeBot", "Google-Extended", "Googlebot", "Applebot", "Applebot-Extended", "CCBot", "Bingbot" ] }, "default": [] }, "extraUserAgents": { "title": "Other robots.txt names", "type": "array", "description": "Up to 10 more crawler names to evaluate in robots.txt only (no test requests), e.g. Amazonbot, meta-externalagent, Bytespider.", "default": [], "items": { "type": "string" } }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Minimum pause between requests to the same site.", "default": 1000 }, "saveReports": { "title": "Save Markdown reports", "type": "boolean", "description": "Save a readable report per website (REPORT-*) and a SUMMARY in the key-value store.", "default": true }, "aiSummary": { "title": "AI-written summary (optional, your OpenAI key)", "type": "boolean", "description": "Adds a short plain-English summary written by OpenAI from the audit findings. Needs your own OpenAI API key below; billed by OpenAI to you. The audit itself never needs AI.", "default": false }, "openaiApiKey": { "title": "OpenAI API key", "type": "string", "description": "Only used when AI-written summary is on. Stored encrypted by Apify." }, "openaiModel": { "title": "OpenAI model", "type": "string", "description": "Model for the summary.", "default": "gpt-6-luna" } } }, "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 } } } } } } } } } }