{"openapi":"3.1.0","info":{"title":"Factget Crawl","version":"0.1.0"},"paths":{"/v1/scrape":{"post":{"summary":"Scrape","description":"Scrape one URL. Waits up to ``timeout`` ms; past it, ``202 {id, url}``.","operationId":"scrape_v1_scrape_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/scrape/{job_id}":{"get":{"summary":"Scrape Status","description":"A scrape's result once done (what the POST would have returned), else ``202``.","operationId":"scrape_status_v1_scrape__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/map":{"post":{"summary":"Map Site","description":"A site's URLs (sitemaps, link crawl, Common Crawl, Wayback), ranked by ``search``.","operationId":"map_site_v1_map_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/map/{job_id}":{"get":{"summary":"Map Status","operationId":"map_status_v1_map__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage":{"get":{"summary":"Usage","description":"Remaining credits and the last 30 days of usage for the calling account.","operationId":"usage_v1_usage_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Usage V1 Usage Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batch/scrape":{"post":{"summary":"Batch Scrape","description":"Scrape many URLs as one async job; poll ``url`` (or use ``webhook``).","operationId":"batch_scrape_v1_batch_scrape_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Scrape V1 Batch Scrape Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batch/scrape/{job_id}":{"get":{"summary":"Batch Status","description":"Status and the next pages of results after ``cursor``; follow ``next``.","operationId":"batch_status_v1_batch_scrape__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Cursor"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Status V1 Batch Scrape  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Batch Cancel","operationId":"batch_cancel_v1_batch_scrape__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Cancel V1 Batch Scrape  Job Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/batch/scrape/{job_id}/errors":{"get":{"summary":"Batch Errors","operationId":"batch_errors_v1_batch_scrape__job_id__errors_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Errors V1 Batch Scrape  Job Id  Errors Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/crawl":{"post":{"summary":"Crawl","description":"Crawl a site within limits as an async job; poll ``url`` (or use ``webhook``).","operationId":"crawl_v1_crawl_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl V1 Crawl Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/crawl/{job_id}":{"get":{"summary":"Crawl Status","operationId":"crawl_status_v1_crawl__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Cursor"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl Status V1 Crawl  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Crawl Cancel","operationId":"crawl_cancel_v1_crawl__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl Cancel V1 Crawl  Job Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/crawl/{job_id}/errors":{"get":{"summary":"Crawl Errors","operationId":"crawl_errors_v1_crawl__job_id__errors_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl Errors V1 Crawl  Job Id  Errors Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/jobs":{"get":{"summary":"Jobs","description":"The account's jobs, newest first.","operationId":"jobs_v1_jobs_get","parameters":[{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Jobs V1 Jobs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/changes":{"get":{"summary":"Changes Inbox","description":"Every monitor's changes at its alert granularity, newest first;\n``verdict`` filters (relevant, possible, not_relevant, pending,\nunchecked, none), ``days`` looks back.","operationId":"changes_inbox_v1_monitors_changes_get","parameters":[{"name":"verdict","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Verdict"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":90,"minimum":1},{"type":"null"}],"title":"Days"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Changes Inbox V1 Monitors Changes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/runs":{"get":{"summary":"Account Runs","description":"All monitors' runs, newest first; ``status`` filters.","operationId":"account_runs_v1_monitors_runs_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Status"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Account Runs V1 Monitors Runs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/schedule":{"get":{"summary":"Schedule Forecast","description":"The active monitors' runs in the next ``hours``: fetches, the busiest\nquarter hour, credits at least and at most.","operationId":"schedule_forecast_v1_monitors_schedule_get","parameters":[{"name":"hours","in":"query","required":false,"schema":{"type":"integer","maximum":168,"minimum":1,"default":24,"title":"Hours"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Schedule Forecast V1 Monitors Schedule Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/schedule/preview":{"post":{"summary":"Schedule Preview","description":"Check a schedule against the plan and list its next times.","operationId":"schedule_preview_v1_monitors_schedule_preview_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulePreview"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Schedule Preview V1 Monitors Schedule Preview Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/drafts":{"post":{"summary":"Create Draft","description":"Start setting up a monitor: the page is loaded twice in Chrome (a page\nreplica to pick from, then a noise check). Poll the draft until ready.","operationId":"create_draft_v1_monitors_drafts_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Draft V1 Monitors Drafts Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/drafts/{draft_id}":{"get":{"summary":"Get Draft","description":"A draft: its status, replica link, noise and proposals.","operationId":"get_draft_v1_monitors_drafts__draft_id__get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","title":"Draft Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Draft V1 Monitors Drafts  Draft Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/drafts/{draft_id}/elements":{"get":{"summary":"Get Draft Elements","description":"The replica's element map: id, tag, role, box, text, parent.","operationId":"get_draft_elements_v1_monitors_drafts__draft_id__elements_get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","title":"Draft Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Draft Elements V1 Monitors Drafts  Draft Id  Elements Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/drafts/{draft_id}/elements/{fgid}":{"get":{"summary":"Get Draft Element","description":"One element: what it yields and the selectors that would track it.","operationId":"get_draft_element_v1_monitors_drafts__draft_id__elements__fgid__get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","title":"Draft Id"}},{"name":"fgid","in":"path","required":true,"schema":{"type":"string","title":"Fgid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Draft Element V1 Monitors Drafts  Draft Id  Elements  Fgid  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors":{"post":{"summary":"Create Monitor","description":"Watch URLs on a schedule. Its first run is at ``nextRunAt``.","operationId":"create_monitor_v1_monitors_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Monitor V1 Monitors Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Monitors","description":"The account's monitors, newest first; ``history`` adds each one's\nlast 14 runs and last change.","operationId":"monitors_v1_monitors_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"history","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"History"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitors V1 Monitors Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}":{"get":{"summary":"Get Monitor","operationId":"get_monitor_v1_monitors__monitor_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor V1 Monitors  Monitor Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"summary":"Update Monitor","description":"Change, pause (``status: paused``) or resume a monitor.","operationId":"update_monitor_v1_monitors__monitor_id__patch","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Update Monitor V1 Monitors  Monitor Id  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Monitor","operationId":"delete_monitor_v1_monitors__monitor_id__delete","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Monitor V1 Monitors  Monitor Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/run":{"post":{"summary":"Run Monitor","description":"Run now, outside the schedule. If a run is going, that one is returned\n(``started: false``).","operationId":"run_monitor_v1_monitors__monitor_id__run_post","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Run Monitor V1 Monitors  Monitor Id  Run Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/runs":{"get":{"summary":"Monitor Runs","description":"The monitor's runs, newest first.","operationId":"monitor_runs_v1_monitors__monitor_id__runs_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Runs V1 Monitors  Monitor Id  Runs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/runs/{run_id}":{"get":{"summary":"Get Monitor Run","description":"One run: its stages' counts, each page's snapshot, what evaluation found.","operationId":"get_monitor_run_v1_monitors__monitor_id__runs__run_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor Run V1 Monitors  Monitor Id  Runs  Run Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/snapshots":{"get":{"summary":"Monitor Snapshots","description":"Snapshots newest first, with their hashes and change flags; ``url``\nkeeps one page's timeline.","operationId":"monitor_snapshots_v1_monitors__monitor_id__snapshots_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Snapshots V1 Monitors  Monitor Id  Snapshots Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/snapshots/{snapshot_id}":{"get":{"summary":"Get Monitor Snapshot","description":"One snapshot with its normalized markdown.","operationId":"get_monitor_snapshot_v1_monitors__monitor_id__snapshots__snapshot_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"snapshot_id","in":"path","required":true,"schema":{"type":"integer","minimum":1,"title":"Snapshot Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor Snapshot V1 Monitors  Monitor Id  Snapshots  Snapshot Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/changes":{"get":{"summary":"Monitor Changes","description":"Watch results that triggered, newest first.","operationId":"monitor_changes_v1_monitors__monitor_id__changes_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"granularity","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/Granularity"},{"type":"null"}],"title":"Granularity"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Changes V1 Monitors  Monitor Id  Changes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/diff":{"get":{"summary":"Get Monitor Diff","description":"A page's precomputed diff for a granularity on a day (``at``, in the\nmonitor's timezone; the latest run without it), or ``from``/``to``: any\ntwo snapshots of one page.","operationId":"get_monitor_diff_v1_monitors__monitor_id__diff_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"granularity","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Granularity","default":"run"}},{"name":"at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"At"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"To"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor Diff V1 Monitors  Monitor Id  Diff Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitors/{monitor_id}/changes/{result_id}/feedback":{"post":{"summary":"Change Feedback","description":"Say whether a change mattered; \"not_relevant\" ones teach the watch's intent.","operationId":"change_feedback_v1_monitors__monitor_id__changes__result_id__feedback_post","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"result_id","in":"path","required":true,"schema":{"type":"integer","minimum":1,"title":"Result Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feedback"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Change Feedback V1 Monitors  Monitor Id  Changes  Result Id  Feedback Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/account":{"get":{"tags":["console"],"summary":"Account","description":"The team's Crawl account (made on first call), its limits and this month's use.","operationId":"account_v1_console_account_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Account V1 Console Account Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/keys":{"get":{"tags":["console"],"summary":"List Keys","operationId":"list_keys_v1_console_keys_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Keys V1 Console Keys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["console"],"summary":"Create Key","description":"A new API key; ``secret`` is returned this once.","operationId":"create_key_v1_console_keys_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewKeyRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Key V1 Console Keys Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/keys/{key_id}":{"delete":{"tags":["console"],"summary":"Revoke Key","operationId":"revoke_key_v1_console_keys__key_id__delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","title":"Key Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Revoke Key V1 Console Keys  Key Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/jobs":{"get":{"tags":["console"],"summary":"List Jobs","description":"The team's jobs, newest first; pass ``next`` back as ``cursor``.","operationId":"list_jobs_v1_console_jobs_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Jobs V1 Console Jobs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/jobs/{job_id}":{"get":{"tags":["console"],"summary":"Job Detail","operationId":"job_detail_v1_console_jobs__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Job Detail V1 Console Jobs  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["console"],"summary":"Cancel Job","operationId":"cancel_job_v1_console_jobs__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Cancel Job V1 Console Jobs  Job Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/usage":{"get":{"tags":["console"],"summary":"Usage","description":"A month's usage (``month=YYYY-MM``, default this one), by UTC day.","operationId":"usage_v1_console_usage_get","parameters":[{"name":"month","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Month"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Usage V1 Console Usage Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/scrape":{"post":{"tags":["console"],"summary":"Scrape","description":"``POST /v1/scrape`` for the console: same body and answer, billed to the team.","operationId":"scrape_v1_console_scrape_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/scrape/{job_id}":{"get":{"tags":["console"],"summary":"Console Scrape Status","description":"A console scrape that outlived its ``timeout`` (the ``202``'s ``url``).","operationId":"console_scrape_status_v1_console_scrape__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/batch/scrape":{"post":{"tags":["console"],"summary":"Batch Scrape","description":"``POST /v1/batch/scrape`` for the console; poll ``url``.","operationId":"batch_scrape_v1_console_batch_scrape_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchScrapeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Scrape V1 Console Batch Scrape Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/batch/scrape/{job_id}":{"get":{"tags":["console"],"summary":"Console Batch Status","description":"Status and the next pages of results after ``cursor``; follow ``next``.","operationId":"console_batch_status_v1_console_batch_scrape__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Cursor"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Batch Status V1 Console Batch Scrape  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/crawl":{"post":{"tags":["console"],"summary":"Crawl","description":"``POST /v1/crawl`` for the console; poll ``url``.","operationId":"crawl_v1_console_crawl_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl V1 Console Crawl Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/crawl/{job_id}":{"get":{"tags":["console"],"summary":"Console Crawl Status","operationId":"console_crawl_status_v1_console_crawl__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Cursor"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Crawl Status V1 Console Crawl  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/map":{"post":{"tags":["console"],"summary":"Map Site","description":"``POST /v1/map`` for the console: same body and answer (``202`` if it runs long).","operationId":"map_site_v1_console_map_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/map/{job_id}":{"get":{"tags":["console"],"summary":"Console Map Status","operationId":"console_map_status_v1_console_map__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/live":{"post":{"tags":["console"],"summary":"Start Live","description":"A browser on the page for the setup screen: connect to ``wsUrl`` and send\n``{\"t\": \"auth\", \"token\"}`` first. One per console user at a time.","operationId":"start_live_v1_console_monitors_live_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveStart"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Start Live V1 Console Monitors Live Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/live/{session_id}":{"delete":{"tags":["console"],"summary":"End Live","operationId":"end_live_v1_console_monitors_live__session_id__delete","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response End Live V1 Console Monitors Live  Session Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/changes":{"get":{"tags":["console"],"summary":"Console Changes Inbox","description":"Every monitor's changes at its alert granularity, newest first;\n``verdict`` filters (relevant, possible, not_relevant, pending,\nunchecked, none), ``days`` looks back.","operationId":"console_changes_inbox_v1_console_monitors_changes_get","parameters":[{"name":"verdict","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Verdict"}},{"name":"days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":90,"minimum":1},{"type":"null"}],"title":"Days"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Changes Inbox V1 Console Monitors Changes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/runs":{"get":{"tags":["console"],"summary":"Console Account Runs","description":"All monitors' runs, newest first; ``status`` filters.","operationId":"console_account_runs_v1_console_monitors_runs_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Status"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Account Runs V1 Console Monitors Runs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/schedule":{"get":{"tags":["console"],"summary":"Schedule Forecast","description":"The active monitors' runs in the next ``hours``: fetches, the busiest\nquarter hour, credits at least and at most.","operationId":"schedule_forecast_v1_console_monitors_schedule_get","parameters":[{"name":"hours","in":"query","required":false,"schema":{"type":"integer","maximum":168,"minimum":1,"default":24,"title":"Hours"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Schedule Forecast V1 Console Monitors Schedule Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/schedule/preview":{"post":{"tags":["console"],"summary":"Schedule Preview","description":"Check a schedule against the plan and list its next times.","operationId":"schedule_preview_v1_console_monitors_schedule_preview_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulePreview"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Schedule Preview V1 Console Monitors Schedule Preview Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/drafts":{"post":{"tags":["console"],"summary":"Create Draft","description":"Start setting up a monitor: the page is loaded twice in Chrome (a page\nreplica to pick from, then a noise check). Poll the draft until ready.","operationId":"create_draft_v1_console_monitors_drafts_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Draft V1 Console Monitors Drafts Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/drafts/{draft_id}":{"get":{"tags":["console"],"summary":"Get Draft","description":"A draft: its status, replica link, noise and proposals.","operationId":"get_draft_v1_console_monitors_drafts__draft_id__get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","title":"Draft Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Draft V1 Console Monitors Drafts  Draft Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/drafts/{draft_id}/elements":{"get":{"tags":["console"],"summary":"Get Draft Elements","description":"The replica's element map: id, tag, role, box, text, parent.","operationId":"get_draft_elements_v1_console_monitors_drafts__draft_id__elements_get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","title":"Draft Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Draft Elements V1 Console Monitors Drafts  Draft Id  Elements Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/drafts/{draft_id}/elements/{fgid}":{"get":{"tags":["console"],"summary":"Get Draft Element","description":"One element: what it yields and the selectors that would track it.","operationId":"get_draft_element_v1_console_monitors_drafts__draft_id__elements__fgid__get","parameters":[{"name":"draft_id","in":"path","required":true,"schema":{"type":"string","title":"Draft Id"}},{"name":"fgid","in":"path","required":true,"schema":{"type":"string","title":"Fgid"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Draft Element V1 Console Monitors Drafts  Draft Id  Elements  Fgid  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors":{"post":{"tags":["console"],"summary":"Create Monitor","description":"Watch URLs on a schedule. Its first run is at ``nextRunAt``.","operationId":"create_monitor_v1_console_monitors_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Monitor V1 Console Monitors Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["console"],"summary":"Console Monitors","description":"The account's monitors, newest first; ``history`` adds each one's\nlast 14 runs and last change.","operationId":"console_monitors_v1_console_monitors_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"history","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"History"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Monitors V1 Console Monitors Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}":{"get":{"tags":["console"],"summary":"Get Monitor","operationId":"get_monitor_v1_console_monitors__monitor_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor V1 Console Monitors  Monitor Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["console"],"summary":"Update Monitor","description":"Change, pause (``status: paused``) or resume a monitor.","operationId":"update_monitor_v1_console_monitors__monitor_id__patch","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Update Monitor V1 Console Monitors  Monitor Id  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["console"],"summary":"Delete Monitor","operationId":"delete_monitor_v1_console_monitors__monitor_id__delete","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Monitor V1 Console Monitors  Monitor Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/run":{"post":{"tags":["console"],"summary":"Run Monitor","description":"Run now, outside the schedule. If a run is going, that one is returned\n(``started: false``).","operationId":"run_monitor_v1_console_monitors__monitor_id__run_post","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Run Monitor V1 Console Monitors  Monitor Id  Run Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/runs":{"get":{"tags":["console"],"summary":"Console Monitor Runs","description":"The monitor's runs, newest first.","operationId":"console_monitor_runs_v1_console_monitors__monitor_id__runs_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Monitor Runs V1 Console Monitors  Monitor Id  Runs Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/runs/{run_id}":{"get":{"tags":["console"],"summary":"Get Monitor Run","description":"One run: its stages' counts, each page's snapshot, what evaluation found.","operationId":"get_monitor_run_v1_console_monitors__monitor_id__runs__run_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor Run V1 Console Monitors  Monitor Id  Runs  Run Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/snapshots":{"get":{"tags":["console"],"summary":"Console Monitor Snapshots","description":"Snapshots newest first, with their hashes and change flags; ``url``\nkeeps one page's timeline.","operationId":"console_monitor_snapshots_v1_console_monitors__monitor_id__snapshots_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Monitor Snapshots V1 Console Monitors  Monitor Id  Snapshots Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/snapshots/{snapshot_id}":{"get":{"tags":["console"],"summary":"Get Monitor Snapshot","description":"One snapshot with its normalized markdown.","operationId":"get_monitor_snapshot_v1_console_monitors__monitor_id__snapshots__snapshot_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"snapshot_id","in":"path","required":true,"schema":{"type":"integer","minimum":1,"title":"Snapshot Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor Snapshot V1 Console Monitors  Monitor Id  Snapshots  Snapshot Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/changes":{"get":{"tags":["console"],"summary":"Console Monitor Changes","description":"Watch results that triggered, newest first.","operationId":"console_monitor_changes_v1_console_monitors__monitor_id__changes_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"granularity","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/Granularity"},{"type":"null"}],"title":"Granularity"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Console Monitor Changes V1 Console Monitors  Monitor Id  Changes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/diff":{"get":{"tags":["console"],"summary":"Get Monitor Diff","description":"A page's precomputed diff for a granularity on a day (``at``, in the\nmonitor's timezone; the latest run without it), or ``from``/``to``: any\ntwo snapshots of one page.","operationId":"get_monitor_diff_v1_console_monitors__monitor_id__diff_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"granularity","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Granularity","default":"run"}},{"name":"at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"At"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"To"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Monitor Diff V1 Console Monitors  Monitor Id  Diff Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/console/monitors/{monitor_id}/changes/{result_id}/feedback":{"post":{"tags":["console"],"summary":"Change Feedback","description":"Say whether a change mattered; \"not_relevant\" ones teach the watch's intent.","operationId":"change_feedback_v1_console_monitors__monitor_id__changes__result_id__feedback_post","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"result_id","in":"path","required":true,"schema":{"type":"integer","minimum":1,"title":"Result Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feedback"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Change Feedback V1 Console Monitors  Monitor Id  Changes  Result Id  Feedback Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AlertDelivery":{"type":"string","enum":["instant","hourly","daily"],"title":"AlertDelivery"},"AlertsSpec":{"properties":{"email":{"type":"boolean","title":"Email","default":true},"webhook":{"anyOf":[{"$ref":"#/components/schemas/MonitorWebhook"},{"type":"null"}]},"delivery":{"$ref":"#/components/schemas/AlertDelivery","default":"instant"}},"additionalProperties":false,"type":"object","title":"AlertsSpec"},"BatchScrapeRequest":{"properties":{"origin":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Origin"},"formats":{"items":{"type":"string","enum":["markdown","html","rawHtml","links","extract"]},"type":"array","minItems":1,"title":"Formats"},"onlyMainContent":{"type":"boolean","title":"Onlymaincontent","default":true},"includeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Includetags"},"excludeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Excludetags"},"waitFor":{"type":"integer","maximum":30000.0,"minimum":0.0,"title":"Waitfor","default":0},"jsCode":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Jscode"},"extract":{"anyOf":[{"$ref":"#/components/schemas/ExtractSpec"},{"type":"null"}]},"urls":{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1,"title":"Urls"},"ignoreInvalidURLs":{"type":"boolean","title":"Ignoreinvalidurls","default":false},"webhook":{"anyOf":[{"$ref":"#/components/schemas/WebhookSpec"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["urls"],"title":"BatchScrapeRequest"},"ConditionSpec":{"properties":{"type":{"$ref":"#/components/schemas/ConditionType"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"text":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Text"},"regex":{"type":"boolean","title":"Regex","default":false}},"additionalProperties":false,"type":"object","required":["type"],"title":"ConditionSpec","description":"One deterministic condition; ``value`` or ``text`` as its type needs."},"ConditionType":{"type":"string","enum":["change_score_at_least","text_contains","text_not_contains","number_changed","number_rises","number_falls","number_change_pct_at_least","number_crosses","element_missing","element_appeared","status_changed"],"title":"ConditionType","description":"Deterministic conditions, checked before any LLM."},"CrawlRequest":{"properties":{"origin":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Origin"},"url":{"type":"string","title":"Url"},"limit":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Limit","default":100},"maxDepth":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Maxdepth"},"maxDiscoveryDepth":{"type":"integer","maximum":100.0,"minimum":0.0,"title":"Maxdiscoverydepth","default":10},"includePaths":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Includepaths"},"excludePaths":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Excludepaths"},"allowSubdomains":{"type":"boolean","title":"Allowsubdomains","default":false},"crawlEntireDomain":{"type":"boolean","title":"Crawlentiredomain","default":false},"allowBackwardLinks":{"type":"boolean","title":"Allowbackwardlinks","default":false},"sitemap":{"type":"string","enum":["include","skip","only"],"title":"Sitemap","default":"include"},"ignoreSitemap":{"type":"boolean","title":"Ignoresitemap","default":false},"ignoreQueryParameters":{"type":"boolean","title":"Ignorequeryparameters","default":false},"scrapeOptions":{"$ref":"#/components/schemas/ScrapeOptionsModel"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/WebhookSpec"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["url"],"title":"CrawlRequest"},"DraftCreate":{"properties":{"url":{"type":"string","title":"Url"},"ask":{"anyOf":[{"type":"string","maxLength":1000,"minLength":1},{"type":"null"}],"title":"Ask"},"scrapeOptions":{"$ref":"#/components/schemas/MonitorScrapeOptions"}},"additionalProperties":false,"type":"object","required":["url"],"title":"DraftCreate"},"ExtractSpec":{"properties":{"type":{"type":"string","enum":["css","xpath","regex"],"title":"Type"},"schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Schema"}},"additionalProperties":false,"type":"object","required":["type"],"title":"ExtractSpec","description":"Structured extraction without an LLM: CSS or XPath field schemas, or\nregex (``{\"patterns\": [...], \"custom_patterns\": {...}}``)."},"Feedback":{"properties":{"verdict":{"type":"string","enum":["relevant","not_relevant"],"title":"Verdict"}},"additionalProperties":false,"type":"object","required":["verdict"],"title":"Feedback"},"Granularity":{"type":"string","enum":["run","day","week","month"],"title":"Granularity","description":"Which baselines each snapshot is compared with (\"Granularities and baselines\")."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"KeyMode":{"type":"string","enum":["live","test"],"title":"KeyMode","description":"Both modes crawl and are billed alike; the mode only labels a key, so\nan account can tell its test traffic from its live traffic."},"KeyScope":{"type":"string","enum":["scrape","map","crawl","jobs","usage","monitors"],"title":"KeyScope","description":"``api_keys.scopes`` is a text array, so adding a scope (``monitors``\nin Phase 7) is a new value here, not a migration."},"LiveStart":{"properties":{"url":{"type":"string","title":"Url"},"steps":{"anyOf":[{"items":{"$ref":"#/components/schemas/SetupStep"},"type":"array","maxItems":10},{"type":"null"}],"title":"Steps"}},"additionalProperties":false,"type":"object","required":["url"],"title":"LiveStart"},"MapRequest":{"properties":{"origin":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Origin"},"url":{"type":"string","title":"Url"},"search":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Search"},"limit":{"type":"integer","maximum":30000.0,"minimum":1.0,"title":"Limit","default":5000},"includeSubdomains":{"type":"boolean","title":"Includesubdomains","default":false},"sources":{"anyOf":[{"items":{"type":"string","enum":["auto","sitemap","crawl","cc","archive"]},"type":"array"},{"type":"null"}],"title":"Sources"},"ignoreSitemap":{"type":"boolean","title":"Ignoresitemap","default":false},"sitemapOnly":{"type":"boolean","title":"Sitemaponly","default":false},"liveCheck":{"type":"boolean","title":"Livecheck","default":false},"timeout":{"anyOf":[{"type":"integer","maximum":300000.0,"minimum":10000.0},{"type":"null"}],"title":"Timeout"}},"additionalProperties":false,"type":"object","required":["url"],"title":"MapRequest"},"MonitorCreate":{"properties":{"origin":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Origin"},"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name"},"draftId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Draftid"},"acceptProposals":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":5,"minItems":1},{"type":"null"}],"title":"Acceptproposals"},"urls":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1},{"type":"null"}],"title":"Urls"},"schedule":{"$ref":"#/components/schemas/ScheduleSpec"},"watches":{"items":{"$ref":"#/components/schemas/WatchSpec"},"type":"array","maxItems":20,"minItems":1,"title":"Watches"},"granularities":{"items":{"$ref":"#/components/schemas/Granularity"},"type":"array","minItems":1,"title":"Granularities"},"scrapeOptions":{"$ref":"#/components/schemas/MonitorScrapeOptions"},"alerts":{"$ref":"#/components/schemas/AlertsSpec"},"noise":{"$ref":"#/components/schemas/NoiseSpec"}},"additionalProperties":false,"type":"object","required":["name","schedule"],"title":"MonitorCreate"},"MonitorScrapeOptions":{"properties":{"onlyMainContent":{"type":"boolean","title":"Onlymaincontent","default":true},"includeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Includetags"},"excludeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Excludetags"},"waitFor":{"type":"integer","maximum":30000.0,"minimum":0.0,"title":"Waitfor","default":0},"jsCode":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Jscode"},"steps":{"anyOf":[{"items":{"$ref":"#/components/schemas/SetupStep"},"type":"array","maxItems":10},{"type":"null"}],"title":"Steps"}},"additionalProperties":false,"type":"object","title":"MonitorScrapeOptions","description":"How each page is fetched: the scrape options that shape what a run sees."},"MonitorStatus":{"type":"string","enum":["active","paused"],"title":"MonitorStatus"},"MonitorUpdate":{"properties":{"origin":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Origin"},"name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Name"},"urls":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1},{"type":"null"}],"title":"Urls"},"schedule":{"anyOf":[{"$ref":"#/components/schemas/ScheduleSpec"},{"type":"null"}]},"watches":{"anyOf":[{"items":{"$ref":"#/components/schemas/WatchSpec"},"type":"array","maxItems":20,"minItems":1},{"type":"null"}],"title":"Watches"},"granularities":{"anyOf":[{"items":{"$ref":"#/components/schemas/Granularity"},"type":"array","minItems":1},{"type":"null"}],"title":"Granularities"},"scrapeOptions":{"anyOf":[{"$ref":"#/components/schemas/MonitorScrapeOptions"},{"type":"null"}]},"alerts":{"anyOf":[{"$ref":"#/components/schemas/AlertsSpec"},{"type":"null"}]},"noise":{"anyOf":[{"$ref":"#/components/schemas/NoiseSpec"},{"type":"null"}]},"status":{"anyOf":[{"$ref":"#/components/schemas/MonitorStatus"},{"type":"null"}]}},"additionalProperties":false,"type":"object","title":"MonitorUpdate","description":"Fields to change; ``watches`` replaces the list (send ``id`` to keep one)."},"MonitorWebhook":{"properties":{"url":{"type":"string","title":"Url"},"headers":{"additionalProperties":{"type":"string"},"type":"object","maxProperties":10,"title":"Headers"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"events":{"items":{"type":"string","const":"change"},"type":"array","minItems":1,"title":"Events"}},"additionalProperties":false,"type":"object","required":["url"],"title":"MonitorWebhook","description":"``alerts.webhook``: a URL, or ``{url, headers, metadata}``; change alerts\nare signed like job webhooks (``X-Factget-Signature``)."},"NewKeyRequest":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name"},"mode":{"$ref":"#/components/schemas/KeyMode","default":"live"},"scopes":{"items":{"$ref":"#/components/schemas/KeyScope"},"type":"array","maxItems":6,"minItems":1,"title":"Scopes"}},"additionalProperties":false,"type":"object","required":["name"],"title":"NewKeyRequest"},"NoiseSpec":{"properties":{"patterns":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Patterns"},"selectors":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Selectors"}},"additionalProperties":false,"type":"object","title":"NoiseSpec","description":"Parts of a page that change by themselves: ``patterns`` (regexes) are\nmasked in the markdown before hashing and diffing; ``selectors`` (CSS)\nare left out of the page when it is scraped."},"SchedulePreview":{"properties":{"schedule":{"$ref":"#/components/schemas/ScheduleSpec"}},"additionalProperties":false,"type":"object","required":["schedule"],"title":"SchedulePreview"},"ScheduleSpec":{"properties":{"cron":{"type":"string","maxLength":120,"minLength":1,"title":"Cron"},"timezone":{"type":"string","maxLength":64,"minLength":1,"title":"Timezone","default":"UTC"},"windowMinutes":{"type":"integer","title":"Windowminutes","default":15}},"additionalProperties":false,"type":"object","required":["cron"],"title":"ScheduleSpec","description":"``cron`` read in ``timezone`` (IANA); runs land within ``windowMinutes``\nof each nominal time (0 = exactly on time, a plan feature)."},"ScrapeOptionsModel":{"properties":{"origin":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Origin"},"formats":{"items":{"type":"string","enum":["markdown","html","rawHtml","links","extract"]},"type":"array","minItems":1,"title":"Formats"},"onlyMainContent":{"type":"boolean","title":"Onlymaincontent","default":true},"includeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Includetags"},"excludeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Excludetags"},"waitFor":{"type":"integer","maximum":30000.0,"minimum":0.0,"title":"Waitfor","default":0},"jsCode":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Jscode"},"extract":{"anyOf":[{"$ref":"#/components/schemas/ExtractSpec"},{"type":"null"}]}},"additionalProperties":false,"type":"object","title":"ScrapeOptionsModel","description":"The scrape options shared by /v1/scrape, /v1/batch/scrape and a\ncrawl's ``scrapeOptions``."},"ScrapeRequest":{"properties":{"origin":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Origin"},"formats":{"items":{"type":"string","enum":["markdown","html","rawHtml","links","extract"]},"type":"array","minItems":1,"title":"Formats"},"onlyMainContent":{"type":"boolean","title":"Onlymaincontent","default":true},"includeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Includetags"},"excludeTags":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":50},{"type":"null"}],"title":"Excludetags"},"waitFor":{"type":"integer","maximum":30000.0,"minimum":0.0,"title":"Waitfor","default":0},"jsCode":{"anyOf":[{"type":"string","maxLength":10000},{"type":"null"}],"title":"Jscode"},"extract":{"anyOf":[{"$ref":"#/components/schemas/ExtractSpec"},{"type":"null"}]},"url":{"type":"string","title":"Url"},"timeout":{"type":"integer","maximum":120000.0,"minimum":1000.0,"title":"Timeout","default":60000}},"additionalProperties":false,"type":"object","required":["url"],"title":"ScrapeRequest"},"SelectorType":{"type":"string","enum":["css","xpath"],"title":"SelectorType"},"SetupStep":{"properties":{"type":{"type":"string","const":"click","title":"Type","default":"click"},"selector":{"anyOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null"}],"title":"Selector"},"xpath":{"anyOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null"}],"title":"Xpath"},"label":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Label"}},"additionalProperties":false,"type":"object","title":"SetupStep","description":"A click replayed before each page is read (the engine's setup_steps):\nwhat someone did to get the page ready in a live session, or a caller's\nown. ``selector`` (CSS) and/or ``xpath``: the first that finds a visible\nelement is clicked; a step whose element never shows is skipped."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WatchMode":{"type":"string","enum":["page","element"],"title":"WatchMode"},"WatchSpec":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string","maxLength":80,"minLength":1},{"type":"null"}],"title":"Name"},"mode":{"$ref":"#/components/schemas/WatchMode","default":"page"},"selector":{"anyOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null"}],"title":"Selector"},"selectorType":{"anyOf":[{"$ref":"#/components/schemas/SelectorType"},{"type":"null"}]},"conditions":{"items":{"$ref":"#/components/schemas/ConditionSpec"},"type":"array","maxItems":10,"title":"Conditions"},"match":{"type":"string","enum":["any","all"],"title":"Match","default":"any"},"intent":{"anyOf":[{"type":"string","maxLength":1000,"minLength":1},{"type":"null"}],"title":"Intent"}},"additionalProperties":false,"type":"object","title":"WatchSpec","description":"A watch. ``id`` keeps an existing watch (and its history) on update."},"WebhookSpec":{"properties":{"url":{"type":"string","title":"Url"},"headers":{"additionalProperties":{"type":"string"},"type":"object","maxProperties":10,"title":"Headers"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"events":{"items":{"type":"string","enum":["started","page","completed","failed"]},"type":"array","minItems":1,"title":"Events"}},"additionalProperties":false,"type":"object","required":["url"],"title":"WebhookSpec","description":"Firecrawl's ``webhook``: a URL, or ``{url, headers, metadata, events}``.\nEvents are sent as ``<batch_scrape|crawl>.<event>``, signed with the\naccount's secret (``X-Factget-Signature: sha256=<hex>``)."}}},"servers":[{"url":"/crawl"}]}