{"openapi":"3.0.3","info":{"title":"Macro Scout API","version":"0.5.0","description":"Web Verification / Site Inspection API — raw facts only, no content archive.\n\n**Auth:** `Authorization: Bearer <api-key>` or `X-Scout-Key: <api-key>`\n\nCreate account-backed keys (`sk_scout_…`) in My Account → Scout.\nDocs: https://docs.macrocontent.dev/scout/"},"servers":[{"url":"https://api.scout.macrocontent.dev","description":"Production"}],"tags":[{"name":"Meta"},{"name":"DNS & robots"},{"name":"Crawl"},{"name":"Domains"},{"name":"Templates"},{"name":"Screenshot"},{"name":"Checks"},{"name":"Extract & inspect"},{"name":"Journey"},{"name":"Performance & sandbox"},{"name":"Jobs"}],"components":{"securitySchemes":{"ScoutApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"Account key `sk_scout_…` or env-configured key"},"ScoutApiKeyHeader":{"type":"apiKey","in":"header","name":"X-Scout-Key"}},"schemas":{"ScoutError":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}},"BrowseOptions":{"type":"object","properties":{"respect_robots":{"type":"boolean","description":"Default true — honor robots.txt"},"wait_for_selector":{"type":"string"},"wait_for_selector_timeout_ms":{"type":"integer","minimum":100,"maximum":120000},"wait_for_selector_required":{"type":"boolean","default":true},"dismiss_cookie_banner":{"type":"boolean","description":"Best-effort click of known cookie CMP accept buttons (fixed allowlist). No domain verify required. Not free interact — custom selectors are rejected."},"device":{"type":"string","description":"Preset from GET /v1/devices"},"detect_captcha":{"type":"boolean"},"color_scheme":{"type":"string","enum":["light","dark","no-preference"]},"locale":{"type":"string"},"user_agent":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"accept_language":{"type":"string"},"encoding":{"type":"string"},"block_resource_types":{"type":"array","items":{"type":"string"}},"block_url_patterns":{"type":"array","items":{"type":"string"}},"block_ads":{"type":"boolean"},"record_har":{"type":"boolean"},"http_auth":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"],"description":"Requires verified domain"},"client_certificates":{"type":"array","description":"mTLS — requires verified domain","items":{"type":"object","required":["origin","cert","key"],"properties":{"origin":{"type":"string"},"cert":{"type":"string"},"key":{"type":"string"},"passphrase":{"type":"string"}}}}}}}},"paths":{"/health":{"get":{"summary":"Health check","description":"Health check\n\n**Credits:** 0","tags":["Meta"],"responses":{"200":{"description":"Service status","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/":{"get":{"summary":"API discovery","description":"API discovery\n\n**Credits:** 0","tags":["Meta"],"responses":{"200":{"description":"Endpoint map","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/usage":{"get":{"summary":"Per-key usage counters","description":"Per-key usage counters\n\n**Credits:** 0","tags":["Meta"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/devices":{"get":{"summary":"Device presets (iPhone, Pixel, …)","description":"Device presets (iPhone, Pixel, …)\n\n**Credits:** 0","tags":["Meta"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/dns":{"post":{"summary":"DNS record lookup","description":"DNS record lookup\n\n**Credits:** 1","tags":["DNS & robots"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","example":"example.com"},"types":{"type":"array","items":{"type":"string","enum":["A","AAAA","TXT","CNAME","MX","NS","SOA"]}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/robots":{"post":{"summary":"robots.txt decision + sitemap URLs","description":"robots.txt decision + sitemap URLs\n\n**Credits:** 1","tags":["DNS & robots"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"user_agent":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/crawl":{"post":{"summary":"Multi-page link discovery (no content archive)","description":"Multi-page link discovery (no content archive)\n\n**Credits:** 15 + 2×max_pages (up-front)","tags":["Crawl"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["start_url"],"properties":{"start_url":{"type":"string","format":"uri"},"max_depth":{"type":"integer","default":2},"max_pages":{"type":"integer","default":25,"maximum":100},"same_origin":{"type":"boolean","default":true},"allow_hosts":{"type":"array","items":{"type":"string"}},"seed_from_sitemap":{"type":"boolean"},"respect_robots":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/domains":{"get":{"summary":"List domains for this API key / account","description":"List domains for this API key / account\n\n**Credits:** 0","tags":["Domains"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}},"post":{"summary":"Register domain for ownership verify","description":"Register domain for ownership verify\n\n**Credits:** 0","tags":["Domains"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","example":"example.com"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/domains/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get domain","description":"Get domain\n\n**Credits:** 0","tags":["Domains"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}},"delete":{"summary":"Delete domain","description":"Delete domain\n\n**Credits:** 0","tags":["Domains"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/domains/{id}/verify":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"post":{"summary":"Verify domain (DNS TXT or well-known file)","description":"Verify domain (DNS TXT or well-known file)\n\n**Credits:** 0","tags":["Domains"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/templates":{"get":{"summary":"List extract templates","description":"List extract templates\n\n**Credits:** 0","tags":["Templates"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}},"post":{"summary":"Create extract template","description":"Create extract template\n\n**Credits:** 0","tags":["Templates"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","fields"],"properties":{"name":{"type":"string"},"slug":{"type":"string"},"hostname":{"type":"string"},"fields":{"type":"array","items":{"type":"object"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/templates/{idOrSlug}":{"parameters":[{"name":"idOrSlug","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Get template","description":"Get template\n\n**Credits:** 0","tags":["Templates"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}},"patch":{"summary":"Update template","description":"Update template\n\n**Credits:** 0","tags":["Templates"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}},"delete":{"summary":"Delete template","description":"Delete template\n\n**Credits:** 0","tags":["Templates"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/screenshot":{"post":{"summary":"Capture screenshot (binary jpeg/png/pdf)","description":"Capture screenshot (binary jpeg/png/pdf)\n\n**Credits:** 8","tags":["Screenshot"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"mode":{"type":"string","enum":["viewport","fullpage"],"default":"fullpage"},"width":{"type":"integer","default":1280},"height":{"type":"integer","default":800},"format":{"type":"string","enum":["jpeg","png","pdf"],"default":"jpeg"},"quality":{"type":"integer","minimum":1,"maximum":100},"wait_ms":{"type":"integer"}}},{"$ref":"#/components/schemas/BrowseOptions"}]}}}},"responses":{"200":{"description":"Image or PDF bytes","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/screenshot/json":{"post":{"summary":"Screenshot as JSON (base64 + optional HAR)","description":"Screenshot as JSON (base64 + optional HAR)\n\n**Credits:** 8","tags":["Screenshot"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"mode":{"type":"string","enum":["viewport","fullpage"]},"format":{"type":"string","enum":["jpeg","png"]}}},{"$ref":"#/components/schemas/BrowseOptions"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/screenshot/viewports":{"post":{"summary":"Multi-viewport screenshots","description":"Multi-viewport screenshots\n\n**Credits:** 8 × viewport count","tags":["Screenshot"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","viewports"],"properties":{"url":{"type":"string","format":"uri"},"viewports":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"device":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/screenshot/diff":{"post":{"summary":"Pixel diff vs client PNG reference","description":"Pixel diff vs client PNG reference\n\n**Credits:** 10","tags":["Screenshot"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","reference_png_base64"],"properties":{"url":{"type":"string","format":"uri"},"reference_png_base64":{"type":"string"},"tolerance":{"type":"number"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/checks/visibility":{"post":{"summary":"Element visibility / occlusion check","description":"Element visibility / occlusion check\n\n**Credits:** 3","tags":["Checks"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","selector"],"properties":{"url":{"type":"string","format":"uri"},"selector":{"type":"string"},"scroll_into_view":{"type":"boolean"},"expect":{"type":"object","additionalProperties":true}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/checks/security":{"post":{"summary":"TLS, headers, mixed content, CMP signals","description":"TLS, headers, mixed content, CMP signals\n\n**Credits:** 5","tags":["Checks"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"respect_robots":{"type":"boolean","description":"Default true — honor robots.txt"},"wait_for_selector":{"type":"string"},"wait_for_selector_timeout_ms":{"type":"integer","minimum":100,"maximum":120000},"wait_for_selector_required":{"type":"boolean","default":true},"dismiss_cookie_banner":{"type":"boolean","description":"Best-effort click of known cookie CMP accept buttons (fixed allowlist). No domain verify required. Not free interact — custom selectors are rejected."},"device":{"type":"string","description":"Preset from GET /v1/devices"},"detect_captcha":{"type":"boolean"},"color_scheme":{"type":"string","enum":["light","dark","no-preference"]},"locale":{"type":"string"},"user_agent":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"accept_language":{"type":"string"},"encoding":{"type":"string"},"block_resource_types":{"type":"array","items":{"type":"string"}},"block_url_patterns":{"type":"array","items":{"type":"string"}},"block_ads":{"type":"boolean"},"record_har":{"type":"boolean"},"http_auth":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"],"description":"Requires verified domain"},"client_certificates":{"type":"array","description":"mTLS — requires verified domain","items":{"type":"object","required":["origin","cert","key"],"properties":{"origin":{"type":"string"},"cert":{"type":"string"},"key":{"type":"string"},"passphrase":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/checks/a11y":{"post":{"summary":"axe-core + contrast/tab/ARIA raw nodes","description":"axe-core + contrast/tab/ARIA raw nodes\n\n**Credits:** 5","tags":["Checks"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"respect_robots":{"type":"boolean","description":"Default true — honor robots.txt"},"wait_for_selector":{"type":"string"},"wait_for_selector_timeout_ms":{"type":"integer","minimum":100,"maximum":120000},"wait_for_selector_required":{"type":"boolean","default":true},"dismiss_cookie_banner":{"type":"boolean","description":"Best-effort click of known cookie CMP accept buttons (fixed allowlist). No domain verify required. Not free interact — custom selectors are rejected."},"device":{"type":"string","description":"Preset from GET /v1/devices"},"detect_captcha":{"type":"boolean"},"color_scheme":{"type":"string","enum":["light","dark","no-preference"]},"locale":{"type":"string"},"user_agent":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"accept_language":{"type":"string"},"encoding":{"type":"string"},"block_resource_types":{"type":"array","items":{"type":"string"}},"block_url_patterns":{"type":"array","items":{"type":"string"}},"block_ads":{"type":"boolean"},"record_har":{"type":"boolean"},"http_auth":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"],"description":"Requires verified domain"},"client_certificates":{"type":"array","description":"mTLS — requires verified domain","items":{"type":"object","required":["origin","cert","key"],"properties":{"origin":{"type":"string"},"cert":{"type":"string"},"key":{"type":"string"},"passphrase":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/checks/tech":{"post":{"summary":"CMS / framework / analytics facts","description":"CMS / framework / analytics facts\n\n**Credits:** 3","tags":["Checks"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"respect_robots":{"type":"boolean","description":"Default true — honor robots.txt"},"wait_for_selector":{"type":"string"},"wait_for_selector_timeout_ms":{"type":"integer","minimum":100,"maximum":120000},"wait_for_selector_required":{"type":"boolean","default":true},"dismiss_cookie_banner":{"type":"boolean","description":"Best-effort click of known cookie CMP accept buttons (fixed allowlist). No domain verify required. Not free interact — custom selectors are rejected."},"device":{"type":"string","description":"Preset from GET /v1/devices"},"detect_captcha":{"type":"boolean"},"color_scheme":{"type":"string","enum":["light","dark","no-preference"]},"locale":{"type":"string"},"user_agent":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"accept_language":{"type":"string"},"encoding":{"type":"string"},"block_resource_types":{"type":"array","items":{"type":"string"}},"block_url_patterns":{"type":"array","items":{"type":"string"}},"block_ads":{"type":"boolean"},"record_har":{"type":"boolean"},"http_auth":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"],"description":"Requires verified domain"},"client_certificates":{"type":"array","description":"mTLS — requires verified domain","items":{"type":"object","required":["origin","cert","key"],"properties":{"origin":{"type":"string"},"cert":{"type":"string"},"key":{"type":"string"},"passphrase":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/extract":{"post":{"summary":"DOM field extract (or template_id)","description":"DOM field extract (or template_id)\n\n**Credits:** 3","tags":["Extract & inspect"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"template_id":{"type":"string"},"fields":{"type":"array","items":{"type":"object","required":["name","selector","type"],"properties":{"name":{"type":"string"},"selector":{"type":"string"},"type":{"type":"string","enum":["exists","text","html","attribute","count","list"]},"attribute":{"type":"string"}}}}}},{"$ref":"#/components/schemas/BrowseOptions"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/inspect":{"post":{"summary":"Page inspect pack (meta, headings, links, …)","description":"Page inspect pack (meta, headings, links, …)\n\n**Credits:** 3","tags":["Extract & inspect"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"include":{"type":"array","items":{"type":"string","enum":["meta","headings","links","images","json_ld","headers","security","tech","files","a11y"]}}}},{"$ref":"#/components/schemas/BrowseOptions"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/files":{"post":{"summary":"Discover downloadable file links","description":"Discover downloadable file links\n\n**Credits:** 3","tags":["Extract & inspect"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"respect_robots":{"type":"boolean","description":"Default true — honor robots.txt"},"wait_for_selector":{"type":"string"},"wait_for_selector_timeout_ms":{"type":"integer","minimum":100,"maximum":120000},"wait_for_selector_required":{"type":"boolean","default":true},"dismiss_cookie_banner":{"type":"boolean","description":"Best-effort click of known cookie CMP accept buttons (fixed allowlist). No domain verify required. Not free interact — custom selectors are rejected."},"device":{"type":"string","description":"Preset from GET /v1/devices"},"detect_captcha":{"type":"boolean"},"color_scheme":{"type":"string","enum":["light","dark","no-preference"]},"locale":{"type":"string"},"user_agent":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"accept_language":{"type":"string"},"encoding":{"type":"string"},"block_resource_types":{"type":"array","items":{"type":"string"}},"block_url_patterns":{"type":"array","items":{"type":"string"}},"block_ads":{"type":"boolean"},"record_har":{"type":"boolean"},"http_auth":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"],"description":"Requires verified domain"},"client_certificates":{"type":"array","description":"mTLS — requires verified domain","items":{"type":"object","required":["origin","cert","key"],"properties":{"origin":{"type":"string"},"cert":{"type":"string"},"key":{"type":"string"},"passphrase":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/pdf/extract":{"post":{"summary":"Extract text from a PDF URL (no OCR)","description":"Extract text from a PDF URL (no OCR)\n\n**Credits:** 4","tags":["Extract & inspect"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/journey":{"post":{"summary":"Multi-step browser journey","description":"Multi-step browser journey\n\n**Credits:** 10 + 2/step (+15 if evaluate; +1/step debug screenshots)","tags":["Journey"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["steps"],"properties":{"steps":{"type":"array","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["navigate","set_content","interact","extract","visibility","screenshot","evaluate","wait_for_function"]},"url":{"type":"string"},"action":{"type":"string","enum":["click","type","fill","scroll","hover","press","select","wait"]},"selector":{"type":"string"},"text":{"type":"string"},"expression":{"type":"string","description":"evaluate — Pro / internal only"}}}},"cookies":{"type":"array","items":{"type":"object"}},"dismiss_cookie_banner":{"type":"boolean","description":"After each navigate/set_content, best-effort dismiss of known CMP banners (fixed allowlist). No domain verify required."},"debug":{"description":"Visual debug: attach page URL + viewport screenshot to each step (or only on error). Prefer on_error_only in production.","oneOf":[{"type":"boolean"},{"type":"object","properties":{"screenshots":{"type":"boolean","default":true},"on_error_only":{"type":"boolean","default":false},"format":{"type":"string","enum":["jpeg","png"]},"quality":{"type":"integer","minimum":1,"maximum":100}}}]},"width":{"type":"integer"},"height":{"type":"integer"},"user_agent":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/performance":{"post":{"summary":"Navigation timing / Web Vitals-style raw metrics","description":"Navigation timing / Web Vitals-style raw metrics\n\n**Credits:** 5","tags":["Performance & sandbox"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"respect_robots":{"type":"boolean","description":"Default true — honor robots.txt"},"wait_for_selector":{"type":"string"},"wait_for_selector_timeout_ms":{"type":"integer","minimum":100,"maximum":120000},"wait_for_selector_required":{"type":"boolean","default":true},"dismiss_cookie_banner":{"type":"boolean","description":"Best-effort click of known cookie CMP accept buttons (fixed allowlist). No domain verify required. Not free interact — custom selectors are rejected."},"device":{"type":"string","description":"Preset from GET /v1/devices"},"detect_captcha":{"type":"boolean"},"color_scheme":{"type":"string","enum":["light","dark","no-preference"]},"locale":{"type":"string"},"user_agent":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"accept_language":{"type":"string"},"encoding":{"type":"string"},"block_resource_types":{"type":"array","items":{"type":"string"}},"block_url_patterns":{"type":"array","items":{"type":"string"}},"block_ads":{"type":"boolean"},"record_har":{"type":"boolean"},"http_auth":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"],"description":"Requires verified domain"},"client_certificates":{"type":"array","description":"mTLS — requires verified domain","items":{"type":"object","required":["origin","cert","key"],"properties":{"origin":{"type":"string"},"cert":{"type":"string"},"key":{"type":"string"},"passphrase":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/sandbox":{"post":{"summary":"Load HTML/JS snippet in isolated page","description":"Load HTML/JS snippet in isolated page\n\n**Credits:** 5","tags":["Performance & sandbox"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"html":{"type":"string"},"url":{"type":"string","format":"uri"},"scripts":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/jobs":{"post":{"summary":"Enqueue batch job (+ optional signed webhook)","description":"Enqueue batch job (+ optional signed webhook)\n\n**Credits:** sum of nested requests","tags":["Jobs"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requests"],"properties":{"webhook_url":{"type":"string","format":"uri"},"webhook_secret":{"type":"string"},"requests":{"type":"array","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["screenshot","extract","visibility","inspect","performance","journey","crawl"]},"body":{"type":"object","additionalProperties":true}}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}},"/v1/jobs/{id}":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"get":{"summary":"Poll job until expires_at","description":"Poll job until expires_at\n\n**Credits:** 0","tags":["Jobs"],"security":[{"ScoutApiKey":[]},{"ScoutApiKeyHeader":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Validation / policy","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"402":{"description":"Credits exhausted","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"403":{"description":"Forbidden / domain verify","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}},"429":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["error","code","retryable"],"properties":{"error":{"type":"string"},"code":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object","additionalProperties":true},"captcha_detected":{"type":"boolean"}}}}}}}}}}}