{
  "openapi": "3.0.1",
  "info": {
    "title": "SiteVerdict — Cookie & Privacy Policy Checker + Draft Generator",
    "description": "Find cookies & trackers your site sets (no click / Reject / Accept) and check them against your cookie & privacy policies: missing cookies, UK GDPR Art 13/14 gaps, ICO/PECR consent issues. Generates a DRAFT cookie table & cookie policy. Not legal advice.",
    "version": "2.0",
    "x-build-id": "DN7QBsqrpiKaCyca9"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/siteverdict~siteverdict-privacy-policy-checker/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-privacy-policy-checker",
        "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/siteverdict~siteverdict-privacy-policy-checker/runs": {
      "post": {
        "operationId": "runs-sync-siteverdict-siteverdict-privacy-policy-checker",
        "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/siteverdict~siteverdict-privacy-policy-checker/run-sync": {
      "post": {
        "operationId": "run-sync-siteverdict-siteverdict-privacy-policy-checker",
        "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": [
          "startUrls"
        ],
        "properties": {
          "startUrls": {
            "title": "Websites to check",
            "type": "array",
            "description": "Home pages of the websites to check. One result (and one 'site-checked' charge) per URL. A missing https:// is added automatically. Each site is loaded 3 times in a real browser (no click, Reject, Accept) and its privacy / cookie policy pages are read.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "generateDrafts": {
            "title": "Generate DRAFT cookie table + cookie policy",
            "type": "boolean",
            "description": "Create a DRAFT cookie policy (Markdown + HTML) and cookie table from the observed cookies, saved in the key-value store. Billed as 'draft-generated' (only when at least one cookie/storage item was observed). Drafts are templates for review by you and a legal adviser - not legal advice.",
            "default": true
          },
          "clientReport": {
            "title": "Client report (PDF + HTML)",
            "type": "boolean",
            "description": "Save a client-ready single-site report (HTML + PDF) with a first-visit screenshot, findings, Art 13/14 checklist, cookie inventory and policy mismatches. Billed as 'client-report' only when the PDF is produced.",
            "default": false
          },
          "reportAgencyName": {
            "title": "Report: your agency / company name (white-label)",
            "type": "string",
            "description": "Shown at the top of the client report. Leave empty for SiteVerdict branding."
          },
          "reportClientName": {
            "title": "Report: client name",
            "type": "string",
            "description": "Optional client name for the report title."
          },
          "privacyPolicyUrl": {
            "title": "Privacy policy URL (optional, single site only)",
            "type": "string",
            "description": "Use this privacy policy page instead of auto-discovery. Only used when exactly one start URL is given."
          },
          "cookiePolicyUrl": {
            "title": "Cookie policy URL (optional, single site only)",
            "type": "string",
            "description": "Use this cookie policy page instead of auto-discovery. Only used when exactly one start URL is given."
          },
          "maxInternalPages": {
            "title": "Internal pages per site",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Also visit up to this many internal pages (same host, linked from the home page) in each consent scenario, to find cookies set on deeper pages. 0 = home page only. Included in the per-site price.",
            "default": 1
          },
          "maxConcurrency": {
            "title": "Max concurrent sites",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "How many sites are checked in parallel. 2 is good for 2 GB memory.",
            "default": 2
          },
          "settleTimeSecs": {
            "title": "Wait after load (seconds)",
            "minimum": 1,
            "maximum": 15,
            "type": "integer",
            "description": "Extra wait after each page load and banner click so delayed tags and banners can appear.",
            "default": 3
          },
          "bannerWaitSecs": {
            "title": "Max wait for a late cookie banner (seconds)",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "If no banner is visible after the page settles, keep checking for up to this long before concluding there is none.",
            "default": 6
          },
          "navigationTimeoutSecs": {
            "title": "Page load timeout (seconds)",
            "minimum": 10,
            "maximum": 120,
            "type": "integer",
            "description": "Maximum time to wait for each page to load.",
            "default": 35
          },
          "locale": {
            "title": "Browser language",
            "type": "string",
            "description": "Browser locale (Accept-Language). Policy checks are English-language heuristics.",
            "default": "en-GB"
          },
          "timezoneId": {
            "title": "Browser time zone",
            "type": "string",
            "description": "IANA time zone, e.g. Europe/London.",
            "default": "Europe/London"
          },
          "userAgent": {
            "title": "Custom browser user agent (optional)",
            "type": "string",
            "description": "Leave empty for a standard desktop Chrome user agent (some consent tools hide the banner from crawler-like agents, which would distort the consent test). robots.txt checks for policy pages always use the token 'SiteVerdict'."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. Banners and tags can be geo-targeted: use Apify Proxy with country GB (or DE, FR...) to see what visitors from that country get. Not used to evade blocking.",
            "default": {
              "useApifyProxy": false
            }
          },
          "monitoringMode": {
            "title": "Monitoring mode (compare with the last run)",
            "type": "boolean",
            "description": "Keep a snapshot per site in a named key-value store and report what changed since the previous run: policy text or URL changed, new cookies not in the policy, new cookies before consent, new / resolved issues. The policy text itself is not stored (only a hash). Schedule the Actor to monitor continuously.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Snapshots are stored in the key-value store 'siteverdict-policy-monitor-<name>' in your account.",
            "default": "default"
          },
          "onlyChanged": {
            "title": "Output only sites that changed",
            "type": "boolean",
            "description": "In monitoring mode, push a dataset item only for sites that changed (and on the first run). Every site is still checked and billed.",
            "default": false
          },
          "alertOn": {
            "title": "Send alerts when",
            "enum": [
              "changes",
              "issues"
            ],
            "type": "string",
            "description": "'changes' (default in monitoring mode) or 'issues' (critical/high findings). One digest per run and destination."
          },
          "slackWebhookUrl": {
            "title": "Slack incoming webhook URL (optional)",
            "type": "string",
            "description": "https://hooks.slack.com/... URL. Secret, never logged. Billed as 'alert-sent' per delivered message."
          },
          "webhookUrl": {
            "title": "Webhook URL (optional)",
            "type": "string",
            "description": "Any public HTTPS endpoint; receives a JSON digest. Secret, never logged. Billed as 'alert-sent' per delivered message."
          },
          "aiFix": {
            "title": "AI-drafted policy wording with your own API key",
            "type": "boolean",
            "description": "Off by default. Uses YOUR Anthropic or OpenAI key to draft the missing cookie-policy rows, privacy-notice wording and consent-tool changes (DRAFT, placeholders for anything not observed). Only the check results are sent. Billed as 'ai-fix-generated' only when a draft is produced; the LLM cost is on your key.",
            "default": false
          },
          "aiProvider": {
            "title": "AI provider",
            "enum": [
              "anthropic",
              "openai"
            ],
            "type": "string",
            "description": "Which API your key belongs to.",
            "default": "anthropic"
          },
          "aiApiKey": {
            "title": "AI API key",
            "type": "string",
            "description": "Your own Anthropic or OpenAI API key. Secret, never logged or output."
          },
          "aiModel": {
            "title": "AI model (optional)",
            "type": "string",
            "description": "Leave empty for the default (Anthropic: claude-sonnet-5-5, mid-priced; OpenAI: gpt-4.1-mini). Any model your key can use, e.g. claude-sonnet-5-5 or claude-haiku-5-5."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}