{"openapi":"3.1.0","info":{"title":"Ragfeed API","description":"Turn websites into LLM-ready markdown and structured data: scrape, crawl, map, search, extract.","version":"1.0.0"},"paths":{"/v2/scrape":{"post":{"tags":["v2"],"summary":"Scrape","operationId":"scrape_v2_scrape_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Scrape V2 Scrape Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/parse":{"post":{"tags":["v2"],"summary":"Parse","description":"Upload a document (PDF incl. scans, Word, Excel, PowerPoint, OpenDocument, EPUB, CSV, HTML).","operationId":"parse_v2_parse_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_parse_v2_parse_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Parse V2 Parse Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/batch/scrape":{"post":{"tags":["v2"],"summary":"Batch Scrape","operationId":"batch_scrape_v2_batch_scrape_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchScrapeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Batch Scrape V2 Batch Scrape Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/batch/scrape/{job_id}":{"get":{"tags":["v2"],"summary":"Batch Status","operationId":"batch_status_v2_batch_scrape__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Status V2 Batch Scrape  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["v2"],"summary":"Batch Cancel","operationId":"batch_cancel_v2_batch_scrape__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Cancel V2 Batch Scrape  Job Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/batch/scrape/{job_id}/errors":{"get":{"tags":["v2"],"summary":"Batch Errors","operationId":"batch_errors_v2_batch_scrape__job_id__errors_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Batch Errors V2 Batch Scrape  Job Id  Errors Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/crawl/params-preview":{"post":{"tags":["v2"],"summary":"Crawl Params Preview","operationId":"crawl_params_preview_v2_crawl_params_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlPreviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Crawl Params Preview V2 Crawl Params Preview Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/crawl":{"post":{"tags":["v2"],"summary":"Crawl","operationId":"crawl_v2_crawl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrawlRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Crawl V2 Crawl Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/crawl/active":{"get":{"tags":["v2"],"summary":"Crawl Active","operationId":"crawl_active_v2_crawl_active_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Crawl Active V2 Crawl Active Get"}}}}}}},"/v2/crawl/{job_id}":{"get":{"tags":["v2"],"summary":"Crawl Status","operationId":"crawl_status_v2_crawl__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl Status V2 Crawl  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["v2"],"summary":"Crawl Cancel","operationId":"crawl_cancel_v2_crawl__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl Cancel V2 Crawl  Job Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/crawl/{job_id}/errors":{"get":{"tags":["v2"],"summary":"Crawl Errors","operationId":"crawl_errors_v2_crawl__job_id__errors_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Crawl Errors V2 Crawl  Job Id  Errors Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/map":{"post":{"tags":["v2"],"summary":"Map Endpoint","operationId":"map_endpoint_v2_map_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Map Endpoint V2 Map Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/search":{"post":{"tags":["v2"],"summary":"Search Endpoint","operationId":"search_endpoint_v2_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Search Endpoint V2 Search Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/extract":{"post":{"tags":["v2"],"summary":"Extract","operationId":"extract_v2_extract_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Extract V2 Extract Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/extract/{job_id}":{"get":{"tags":["v2"],"summary":"Extract Status","operationId":"extract_status_v2_extract__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Extract Status V2 Extract  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/monitor":{"post":{"tags":["v2"],"summary":"Monitor Create","operationId":"monitor_create_v2_monitor_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Create V2 Monitor Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["v2"],"summary":"Monitor List","operationId":"monitor_list_v2_monitor_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor List V2 Monitor Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/monitor/estimate":{"post":{"tags":["v2"],"summary":"Monitor Estimate","operationId":"monitor_estimate_v2_monitor_estimate_post","parameters":[{"name":"monitorId","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Monitorid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Estimate V2 Monitor Estimate Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/monitor/{monitor_id}":{"get":{"tags":["v2"],"summary":"Monitor Get","operationId":"monitor_get_v2_monitor__monitor_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Get V2 Monitor  Monitor Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["v2"],"summary":"Monitor Update","operationId":"monitor_update_v2_monitor__monitor_id__patch","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Update V2 Monitor  Monitor Id  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["v2"],"summary":"Monitor Delete","operationId":"monitor_delete_v2_monitor__monitor_id__delete","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Delete V2 Monitor  Monitor Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/monitor/{monitor_id}/run":{"post":{"tags":["v2"],"summary":"Monitor Run","description":"Starts a check now (any body, also none, is ignored); 409 while a check of this monitor runs.","operationId":"monitor_run_v2_monitor__monitor_id__run_post","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Run V2 Monitor  Monitor Id  Run Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/monitor/{monitor_id}/checks":{"get":{"tags":["v2"],"summary":"Monitor Checks","operationId":"monitor_checks_v2_monitor__monitor_id__checks_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Checks V2 Monitor  Monitor Id  Checks Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/monitor/{monitor_id}/checks/{check_id}":{"get":{"tags":["v2"],"summary":"Monitor Check","operationId":"monitor_check_v2_monitor__monitor_id__checks__check_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}},{"name":"check_id","in":"path","required":true,"schema":{"type":"string","title":"Check Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Monitor Check V2 Monitor  Monitor Id  Checks  Check Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/team/credit-usage":{"get":{"tags":["v2"],"summary":"Credit Usage","operationId":"credit_usage_v2_team_credit_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Credit Usage V2 Team Credit Usage Get"}}}}}}},"/v2/team/credit-usage/historical":{"get":{"tags":["v2"],"summary":"Credit Usage Historical","operationId":"credit_usage_historical_v2_team_credit_usage_historical_get","parameters":[{"name":"byApiKey","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Byapikey"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Credit Usage Historical V2 Team Credit Usage Historical Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/team/queue-status":{"get":{"tags":["v2"],"summary":"Queue Status","operationId":"queue_status_v2_team_queue_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Queue Status V2 Team Queue Status Get"}}}}}}},"/v1/scrape":{"post":{"tags":["v1 (legacy)"],"summary":"Scrape","operationId":"scrape_v1_scrape_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Scrape V1 Scrape Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/crawl":{"post":{"tags":["v1 (legacy)"],"summary":"Crawl","operationId":"crawl_v1_crawl_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Crawl V1 Crawl Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/crawl/active":{"get":{"tags":["v1 (legacy)"],"summary":"Crawl Active","operationId":"crawl_active_v1_crawl_active_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Crawl Active V1 Crawl Active Get"}}}}}}},"/v1/crawl/{job_id}":{"get":{"tags":["v1 (legacy)"],"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":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}}],"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":{"tags":["v1 (legacy)"],"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"}}],"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":{"tags":["v1 (legacy)"],"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"}}],"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/batch/scrape":{"post":{"tags":["v1 (legacy)"],"summary":"Batch Scrape","operationId":"batch_scrape_v1_batch_scrape_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","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":{"tags":["v1 (legacy)"],"summary":"Batch Status","operationId":"batch_status_v1_batch_scrape__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}}],"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":{"tags":["v1 (legacy)"],"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"}}],"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":{"tags":["v1 (legacy)"],"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"}}],"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/map":{"post":{"tags":["v1 (legacy)"],"summary":"Map Endpoint","operationId":"map_endpoint_v1_map_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Map Endpoint V1 Map Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/search":{"post":{"tags":["v1 (legacy)"],"summary":"Search","operationId":"search_v1_search_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Search V1 Search Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/extract":{"post":{"tags":["v1 (legacy)"],"summary":"Extract","operationId":"extract_v1_extract_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Extract V1 Extract Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/extract/{job_id}":{"get":{"tags":["v1 (legacy)"],"summary":"Extract Status","operationId":"extract_status_v1_extract__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Extract Status V1 Extract  Job Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/team/credit-usage":{"get":{"tags":["v1 (legacy)"],"summary":"Credit Usage","operationId":"credit_usage_v1_team_credit_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Credit Usage V1 Team Credit Usage Get"}}}}}}},"/v1/team/credit-usage/historical":{"get":{"tags":["v1 (legacy)"],"summary":"Credit Usage Historical","operationId":"credit_usage_historical_v1_team_credit_usage_historical_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Credit Usage Historical V1 Team Credit Usage Historical Get"}}}}}}}},"components":{"schemas":{"BatchScrapeRequest":{"properties":{"formats":{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array","title":"Formats"},"onlyMainContent":{"type":"boolean","title":"Onlymaincontent","default":true},"onlyCleanContent":{"type":"boolean","title":"Onlycleancontent","default":false},"includeTags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Includetags"},"excludeTags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludetags"},"maxAge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxage"},"minAge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minage"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers"},"waitFor":{"type":"integer","title":"Waitfor","default":0},"mobile":{"type":"boolean","title":"Mobile","default":false},"skipTlsVerification":{"type":"boolean","title":"Skiptlsverification","default":true},"timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout"},"parsers":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array"},{"type":"null"}],"title":"Parsers"},"actions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Actions"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"removeBase64Images":{"type":"boolean","title":"Removebase64Images","default":true},"blockAds":{"type":"boolean","title":"Blockads","default":true},"proxy":{"anyOf":[{"type":"string","enum":["basic","enhanced","auto","stealth"]},{"type":"null"}],"title":"Proxy","default":"auto"},"storeInCache":{"type":"boolean","title":"Storeincache","default":true},"lockdown":{"type":"boolean","title":"Lockdown","default":false},"redactPII":{"anyOf":[{"type":"boolean"},{"additionalProperties":true,"type":"object"}],"title":"Redactpii","default":false},"zeroDataRetention":{"type":"boolean","title":"Zerodataretention","default":false},"urls":{"items":{"type":"string"},"type":"array","title":"Urls"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/Webhook"},{"type":"string"},{"type":"null"}],"title":"Webhook"},"maxConcurrency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxconcurrency"},"ignoreInvalidURLs":{"type":"boolean","title":"Ignoreinvalidurls","default":true}},"additionalProperties":true,"type":"object","required":["urls"],"title":"BatchScrapeRequest"},"Body_parse_v2_parse_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"options":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Options"}},"type":"object","required":["file"],"title":"Body_parse_v2_parse_post"},"CrawlPreviewRequest":{"properties":{"url":{"type":"string","title":"Url"},"prompt":{"type":"string","title":"Prompt"}},"additionalProperties":true,"type":"object","required":["url","prompt"],"title":"CrawlPreviewRequest"},"CrawlRequest":{"properties":{"url":{"type":"string","title":"Url"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"excludePaths":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludepaths"},"includePaths":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Includepaths"},"maxDiscoveryDepth":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxdiscoverydepth"},"sitemap":{"type":"string","enum":["skip","include","only"],"title":"Sitemap","default":"include"},"ignoreQueryParameters":{"type":"boolean","title":"Ignorequeryparameters","default":false},"regexOnFullURL":{"type":"boolean","title":"Regexonfullurl","default":false},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","default":10000},"crawlEntireDomain":{"type":"boolean","title":"Crawlentiredomain","default":false},"allowExternalLinks":{"type":"boolean","title":"Allowexternallinks","default":false},"allowSubdomains":{"type":"boolean","title":"Allowsubdomains","default":false},"ignoreRobotsTxt":{"type":"boolean","title":"Ignorerobotstxt","default":false},"robotsUserAgent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Robotsuseragent"},"delay":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Delay"},"maxConcurrency":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxconcurrency"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/Webhook"},{"type":"string"},{"type":"null"}],"title":"Webhook"},"scrapeOptions":{"anyOf":[{"$ref":"#/components/schemas/ScrapeOptions"},{"type":"null"}]},"zeroDataRetention":{"type":"boolean","title":"Zerodataretention","default":false}},"additionalProperties":true,"type":"object","required":["url"],"title":"CrawlRequest"},"ExtractRequest":{"properties":{"urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Urls"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Schema"},"systemPrompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Systemprompt"},"enableWebSearch":{"type":"boolean","title":"Enablewebsearch","default":false},"ignoreSitemap":{"type":"boolean","title":"Ignoresitemap","default":false},"includeSubdomains":{"type":"boolean","title":"Includesubdomains","default":true},"showSources":{"type":"boolean","title":"Showsources","default":false},"scrapeOptions":{"anyOf":[{"$ref":"#/components/schemas/ScrapeOptions"},{"type":"null"}]},"ignoreInvalidURLs":{"type":"boolean","title":"Ignoreinvalidurls","default":true}},"additionalProperties":true,"type":"object","title":"ExtractRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Location":{"properties":{"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","default":"US"},"languages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Languages"}},"additionalProperties":true,"type":"object","title":"Location"},"MapRequest":{"properties":{"url":{"type":"string","title":"Url"},"search":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"},"sitemap":{"type":"string","enum":["skip","include","only"],"title":"Sitemap","default":"include"},"includeSubdomains":{"type":"boolean","title":"Includesubdomains","default":true},"ignoreQueryParameters":{"type":"boolean","title":"Ignorequeryparameters","default":true},"ignoreCache":{"type":"boolean","title":"Ignorecache","default":false},"limit":{"type":"integer","title":"Limit","default":5000},"timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]}},"additionalProperties":true,"type":"object","required":["url"],"title":"MapRequest"},"MonitorCreateRequest":{"properties":{"name":{"type":"string","title":"Name"},"schedule":{"$ref":"#/components/schemas/MonitorSchedule"},"targets":{"items":{"$ref":"#/components/schemas/MonitorTarget"},"type":"array","title":"Targets"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/MonitorWebhook"},{"type":"string"},{"type":"null"}],"title":"Webhook"},"notification":{"anyOf":[{"$ref":"#/components/schemas/MonitorNotification"},{"type":"null"}]},"retentionDays":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retentiondays"},"goal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Goal"},"judgeEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Judgeenabled"}},"additionalProperties":true,"type":"object","required":["name","schedule","targets"],"title":"MonitorCreateRequest"},"MonitorEmail":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"recipients":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipients"},"includeDiffs":{"type":"boolean","title":"Includediffs","default":false}},"additionalProperties":true,"type":"object","title":"MonitorEmail"},"MonitorNotification":{"properties":{"email":{"anyOf":[{"$ref":"#/components/schemas/MonitorEmail"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"MonitorNotification"},"MonitorSchedule":{"properties":{"cron":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cron"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"}},"additionalProperties":true,"type":"object","title":"MonitorSchedule"},"MonitorTarget":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"type":{"type":"string","enum":["scrape","crawl","search"],"title":"Type"},"urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Urls"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"crawlOptions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Crawloptions"},"scrapeOptions":{"anyOf":[{"$ref":"#/components/schemas/ScrapeOptions"},{"type":"null"}]},"queries":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Queries"},"searchWindow":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Searchwindow"},"maxResults":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxresults"},"includeDomains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Includedomains"},"excludeDomains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludedomains"}},"additionalProperties":true,"type":"object","required":["type"],"title":"MonitorTarget"},"MonitorUpdateRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"status":{"anyOf":[{"type":"string","enum":["active","paused"]},{"type":"null"}],"title":"Status"},"schedule":{"anyOf":[{"$ref":"#/components/schemas/MonitorSchedule"},{"type":"null"}]},"targets":{"anyOf":[{"items":{"$ref":"#/components/schemas/MonitorTarget"},"type":"array"},{"type":"null"}],"title":"Targets"},"webhook":{"anyOf":[{"$ref":"#/components/schemas/MonitorWebhook"},{"type":"string"},{"type":"null"}],"title":"Webhook"},"notification":{"anyOf":[{"$ref":"#/components/schemas/MonitorNotification"},{"type":"null"}]},"retentionDays":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retentiondays"},"goal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Goal"},"judgeEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Judgeenabled"}},"additionalProperties":true,"type":"object","title":"MonitorUpdateRequest","description":"Every field optional; a field sent as null clears it (webhook, notification, goal, judgeEnabled)."},"MonitorWebhook":{"properties":{"url":{"type":"string","title":"Url"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"events":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Events"}},"additionalProperties":true,"type":"object","required":["url"],"title":"MonitorWebhook"},"ScrapeOptions":{"properties":{"formats":{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array","title":"Formats"},"onlyMainContent":{"type":"boolean","title":"Onlymaincontent","default":true},"onlyCleanContent":{"type":"boolean","title":"Onlycleancontent","default":false},"includeTags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Includetags"},"excludeTags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludetags"},"maxAge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxage"},"minAge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minage"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers"},"waitFor":{"type":"integer","title":"Waitfor","default":0},"mobile":{"type":"boolean","title":"Mobile","default":false},"skipTlsVerification":{"type":"boolean","title":"Skiptlsverification","default":true},"timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout"},"parsers":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array"},{"type":"null"}],"title":"Parsers"},"actions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Actions"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"removeBase64Images":{"type":"boolean","title":"Removebase64Images","default":true},"blockAds":{"type":"boolean","title":"Blockads","default":true},"proxy":{"anyOf":[{"type":"string","enum":["basic","enhanced","auto","stealth"]},{"type":"null"}],"title":"Proxy","default":"auto"},"storeInCache":{"type":"boolean","title":"Storeincache","default":true},"lockdown":{"type":"boolean","title":"Lockdown","default":false},"redactPII":{"anyOf":[{"type":"boolean"},{"additionalProperties":true,"type":"object"}],"title":"Redactpii","default":false},"zeroDataRetention":{"type":"boolean","title":"Zerodataretention","default":false}},"additionalProperties":true,"type":"object","title":"ScrapeOptions"},"ScrapeRequest":{"properties":{"formats":{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array","title":"Formats"},"onlyMainContent":{"type":"boolean","title":"Onlymaincontent","default":true},"onlyCleanContent":{"type":"boolean","title":"Onlycleancontent","default":false},"includeTags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Includetags"},"excludeTags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludetags"},"maxAge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxage"},"minAge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minage"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers"},"waitFor":{"type":"integer","title":"Waitfor","default":0},"mobile":{"type":"boolean","title":"Mobile","default":false},"skipTlsVerification":{"type":"boolean","title":"Skiptlsverification","default":true},"timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout"},"parsers":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array"},{"type":"null"}],"title":"Parsers"},"actions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Actions"},"location":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"removeBase64Images":{"type":"boolean","title":"Removebase64Images","default":true},"blockAds":{"type":"boolean","title":"Blockads","default":true},"proxy":{"anyOf":[{"type":"string","enum":["basic","enhanced","auto","stealth"]},{"type":"null"}],"title":"Proxy","default":"auto"},"storeInCache":{"type":"boolean","title":"Storeincache","default":true},"lockdown":{"type":"boolean","title":"Lockdown","default":false},"redactPII":{"anyOf":[{"type":"boolean"},{"additionalProperties":true,"type":"object"}],"title":"Redactpii","default":false},"zeroDataRetention":{"type":"boolean","title":"Zerodataretention","default":false},"url":{"type":"string","title":"Url"}},"additionalProperties":true,"type":"object","required":["url"],"title":"ScrapeRequest"},"SearchRequest":{"properties":{"query":{"type":"string","title":"Query"},"limit":{"type":"integer","title":"Limit","default":10},"sources":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array"},{"type":"null"}],"title":"Sources"},"categories":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}]},"type":"array"},{"type":"null"}],"title":"Categories"},"includeDomains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Includedomains"},"excludeDomains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Excludedomains"},"tbs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tbs"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"safe":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Safe"},"ignoreInvalidURLs":{"type":"boolean","title":"Ignoreinvalidurls","default":false},"timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout"},"scrapeOptions":{"anyOf":[{"$ref":"#/components/schemas/ScrapeOptions"},{"type":"null"}]}},"additionalProperties":true,"type":"object","required":["query"],"title":"SearchRequest"},"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"},"Webhook":{"properties":{"url":{"type":"string","title":"Url"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"events":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Events"}},"additionalProperties":true,"type":"object","required":["url"],"title":"Webhook"}}}}