{
  "openapi": "3.0.1",
  "info": {
    "title": "Ai Visibility Suite - Dark Visitors Alternative",
    "description": "Comprehensive AI bot monitoring, robots.txt analysis, LLMs.txt generation & AI shopping optimization. Monitor AI crawlers visits, check AI compliance, generate AI-friendly configurations, and optimize for AI shopping agents.\n\nAI Bot Directory \nRobots.txt\nLLMs.txt\nAI Shopping\nCompetitor AI Audit",
    "version": "1.0",
    "x-build-id": "dyQvG24BivpAmRT01"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/alizarin_refrigerator-owner~ai-visibility-suite---dark-visitors-alternative/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-ai-visibility-suite---dark-visitors-alternative",
        "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/alizarin_refrigerator-owner~ai-visibility-suite---dark-visitors-alternative/runs": {
      "post": {
        "operationId": "runs-sync-alizarin_refrigerator-owner-ai-visibility-suite---dark-visitors-alternative",
        "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/alizarin_refrigerator-owner~ai-visibility-suite---dark-visitors-alternative/run-sync": {
      "post": {
        "operationId": "run-sync-alizarin_refrigerator-owner-ai-visibility-suite---dark-visitors-alternative",
        "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",
        "required": [
          "urls"
        ],
        "properties": {
          "urls": {
            "title": "Target URLs",
            "type": "array",
            "description": "List of website URLs to analyze. Enter one or more URLs to check for AI visibility and bot compliance.",
            "items": {
              "type": "string"
            }
          },
          "modules": {
            "title": "Analysis Modules",
            "type": "array",
            "description": "Select which analysis modules to run. You can run one, multiple, or all modules.",
            "items": {
              "type": "string",
              "enum": [
                "aiBotDirectory",
                "robotsTxtAnalysis",
                "llmsTxtCheck",
                "llmsTxtGenerator",
                "aiShoppingOptimizer",
                "competitorAudit",
                "botResponseTester"
              ],
              "enumTitles": [
                "AI Bot Directory - Comprehensive database of AI crawlers and bots",
                "Robots.txt Analysis - Check AI bot blocking/allowing status",
                "LLMs.txt Check - Verify if site has LLMs.txt file",
                "LLMs.txt Generator - Generate optimized LLMs.txt for your site",
                "AI Shopping Optimizer - Analyze e-commerce AI readiness",
                "Competitor AI Audit - Compare AI visibility across competitors",
                "Bot Response Tester - Test how site responds to AI bot user agents"
              ]
            },
            "default": [
              "robotsTxtAnalysis",
              "llmsTxtCheck"
            ]
          },
          "runAllModules": {
            "title": "Run All Modules",
            "type": "boolean",
            "description": "Override module selection and run all available analysis modules",
            "default": false
          },
          "botCategories": {
            "title": "Bot Categories to Include",
            "type": "array",
            "description": "Filter which AI bot categories to analyze (leave empty for all)",
            "items": {
              "type": "string",
              "enum": [
                "AI Assistant",
                "AI Search Crawler",
                "AI Data Scraper",
                "AI Agent",
                "Undocumented AI Agent",
                "Intelligence Archiver",
                "AI Search Fetcher"
              ],
              "enumTitles": [
                "AI Assistant",
                "AI Search Crawler",
                "AI Data Scraper",
                "AI Agent",
                "Undocumented AI Agent",
                "Intelligence Archiver",
                "AI Search Fetcher"
              ]
            },
            "default": []
          },
          "sortBotsBy": {
            "title": "Sort Bots By",
            "enum": [
              "name",
              "category",
              "operator",
              "prevalence"
            ],
            "type": "string",
            "description": "How to sort the AI bot directory results",
            "default": "prevalence"
          },
          "generateLlmsTxt": {
            "title": "Generate LLMs.txt if Missing",
            "type": "boolean",
            "description": "Automatically generate an LLMs.txt file if the site doesn't have one",
            "default": false
          },
          "customUserAgents": {
            "title": "Custom Bot User Agents",
            "type": "array",
            "description": "Additional bot user agents to test (one per line)",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "testPaths": {
            "title": "Paths to Test",
            "type": "array",
            "description": "URL paths to test with bot user agents",
            "default": [
              "/",
              "/products",
              "/about"
            ],
            "items": {
              "type": "string"
            }
          },
          "outputFormat": {
            "title": "Output Format",
            "enum": [
              "json",
              "markdown",
              "html"
            ],
            "type": "string",
            "description": "Format for the analysis results",
            "default": "json"
          },
          "demoMode": {
            "title": "Demo Mode",
            "type": "boolean",
            "description": "Run in demo mode with limited features (no charges)",
            "default": false
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "URL to receive notifications (compatible with Zapier, Make/Integromat, n8n, and custom endpoints). Leave empty to disable."
          },
          "webhookOnIssues": {
            "title": "Send Webhook on Issues Found",
            "type": "boolean",
            "description": "Trigger webhook when AI visibility issues are detected",
            "default": true
          },
          "webhookOnLowScore": {
            "title": "Send Webhook on Low Score",
            "type": "boolean",
            "description": "Trigger webhook when AI visibility score falls below threshold",
            "default": true
          },
          "lowScoreThreshold": {
            "title": "Low Score Threshold (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Alert threshold for low AI visibility scores (0-100)",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}