+ Vi>nRt^RIt^RIHtHtHtHtHtHtH t ^RI H t H t H t HtHtHtHtHtHtHtHtHtHtHtHtHtHtHtHtHtHtH t H!t!H"t"H#t#H$t$H%t%H&t&H't'H(t(H)t)H*t*^RI+H,t,^RI-H.t.^RI/H0t1^RI/H2t3^RI/H4t5^R I/H6t7^R I/H8t9^RI/H4t:^R I/H;t<^R I/H=t>^R I/H?t@^RI/HAtB^RICHDtD!RR4tER#)zs Main Firecrawl v2 API client. This module provides the main client class that orchestrates all v2 functionality. N)OptionalListDictAnyCallableUnionLiteral) ClientConfig ScrapeOptionsDocument SearchRequest SearchData SourceOptionCategoryOption CrawlRequest CrawlResponseCrawlJobCrawlParamsRequest PDFParserCrawlParamsData WebhookConfigAgentWebhookConfigCrawlErrorsResponseActiveCrawlsResponse MapOptionsMapData FormatOption WaitActionScreenshotAction ClickAction WriteAction PressAction ScrollAction ScrapeActionExecuteJavascriptAction PDFActionLocationPaginationConfig AgentOptions) HttpClient)FirecrawlError)scrape)crawl)batch)search)map)usage)extract)agent)browserWatcherc8a]tRt^9toRt]V3RlRl4tRV3RlRlltRRRRR RR RR RR RR RRRRRRRRRRRRRRRRRRRRRRRRRRRRR/V3RlRlltRRRRR R RR!R/V3R"lR#lllt V3R$lR%lt V3R&lR'lt RRRRR R RR!R/V3R(lR)lllt V3R*lR+lt R,RR-RR.RR/RRRR0RR RR1RRR/ V3R2lR3lltRRR4RR5RR6RR7RR8RR9R:R.RR;R:RR:R?RR@RRARR1RRBR:RCRDRER:RF^R RRGRRR/V3RHlRIlltRRR4RR5RR6RR7RR8RR9R:R.RR;R:RR:R?RR@RRARR1RRBR:RCRDRER:RR/V3RJlRKlltRRGR/V3RLlRMllltRGR/V3RNlROlltV3RPlRQltV3RRlRSltV3RTlRUltRVRRWRR9RR.RR7RR RRRRR/V3RXlRYlltV3RZlR[ltV3R\lR]ltRRRR^RR_RRrPrrrr )r?r@s"rArBrCosNDND ND$~./ ND $sCx.) ND tCy) NDtCy)ND$D>ND#ND3-NDND%S 4c9n0E+F FGHND$u&{ |}~ND:&ND (~ND 'tn!ND"D>#ND$3-%ND&D>'ND(})ND*#+ND,!-ND.$sCx.)/ND0c]1ND2 3NDrDc \;QJd*RW#WEWgWWWWVVVVVVV34F 'gK RM RM!RW#WEWgWWWWVVVVVVV344'd|\R/\R/RVbRVbRVbRVbRVbR VbR VbR V bR V bR V bRV bRV bRVbRVbRVbRVbRVbRVbRVbRVbRVbP4UUu/uFwppVfK VVbK uppBMRp\P !VP VV4#uuppi)a Scrape a single URL and return the document. Args: url: URL to scrape formats: List of formats to scrape headers: Dictionary of headers to use include_tags: List of tags to include exclude_tags: List of tags to exclude only_main_content: Whether to only scrape the main content timeout: Timeout in milliseconds wait_for: Wait for a specific element to be present mobile: Whether to use mobile mode parsers: List of parsers to use actions: List of actions to perform location: Location to scrape skip_tls_verification: Whether to skip TLS verification remove_base64_images: Whether to remove base64 images fast_mode: Whether to use fast mode use_mock: Whether to use mock mode block_ads: Whether to block ads proxy: Proxy to use max_age: Maximum age of the cache store_in_cache: Whether to store the result in the cache profile: Browser profile for persistent state (e.g. {"name": "my-profile", "saveChanges": True}) Returns: Document c3("TFqRJxK R#5iN.0vs& rA )FirecrawlClient.scrape..se)d1$)dTFr[r\r]r^r_rLr`rarbrcrdrerfrgrhrirjrkrlrmrnNrt)anyr dictitems scrape_moduler+rW)rXr:r[r\r]r^r_rLr`rarbrcrdrerfrgrhrirjrkrlrmrnkrwoptionss&&$$$$$$$$$$$$$$$$$$$$$ rAr+FirecrawlClient.scrapeos,ZSe.>GGrDc <V^8dQhRS[/#rr)r?r@s"rArBrCs--s-rDc $VPV4#z(Deprecated alias for stop_interaction().rrs&&rAstop_interactive_browser(FirecrawlClient.stop_interactive_browser$$V,,rDc <V^8dQhRS[RS[S[,RS[S[,RS[R,RS[S[,RS[S[,/#rr)r?r@s"rArBrCs]   sm   23  #   rDc  0VPVVVVVVR7#)z Deprecated alias for interact().r)rrs&&&$$$$rAscrape_executeFirecrawlClient.scrape_executes,}}     rDc <V^8dQhRS[/#rr)r?r@s"rArBrCs--C-rDc $VPV4#rrrs&&rAdelete_scrape_browser%FirecrawlClient.delete_scrape_browserrrDsources categorieslimittbsignore_invalid_urlsscrape_optionsc <V^8dQhRS[RS[S[S[,,RS[S[S[,,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,R S[S[,R S[S[,R S[/ #) r9queryrrrrrdrrLrrnr;) r=rrrrrPr>r r )r?r@s"rArBrC s)?)?)?$|,- )? T.12 )? } )?c])?3-)?&d^)?#)?!/)?c])? )?rDc  n\VVVVVVVVV V R7 p \P!VPV 4#)av Search for documents. Args: query: Search query string limit: Maximum number of results to return (default: 5) tbs: Time-based search filter location: Location string for search timeout: Request timeout in milliseconds (default: 300000) page_options: Options for scraping individual pages Returns: SearchData containing the search results ) rrrrrrdrrLrrn)r search_moduler.rW) rXrrrrrrdrrLrrnrequests &&$$$$$$$$$ rAr.FirecrawlClient.search sG8 ! 3)#  ##D$4$4g>>rD exclude_paths include_pathsmax_discovery_depthsitemapignore_sitemapignore_query_parametersFcrawl_entire_domainallow_external_linksallow_subdomainsignore_robots_txtdelaymax_concurrencywebhookregex_on_full_urldeduplicate_similar_urlsTzero_data_retention poll_intervalrequest_timeoutc2<V^8dQhRS[RS[S[,RS[S[S[,,RS[S[S[,,RS[S[,RS[S[R,,RS[S[,RS[R S[S[,R S[R S[R S[R S[RS[S[,RS[S[,RS[S[S[S[3,,RS[S[,RS[RS[RS[RS[RS[S[,RS[S[ ,RS[S[,RS[ /#)r9r:rrrrrrrrrrrrrrrrrrrrrLrrnr;onlyincludeskip) r=rrrPrr>rrr rOr)r?r@s"rArBrC6sud d d  d  S * d  S * d &c]d '";<=d !d "&d }d "d #d d  d }!d ""##d $%] 234%d &!/'d ( )d *#'+d ,"-d ./d 0#1d 2"%3d 4c]5d 6 7d rDc TpVfVe V'dRMRp/RVbRVbRVbRVbRVbRVbR V bR V bR V bR V bR V bRVbRVbRVbRVbRVbRVbRVRV/CpVeVVR&\R/VBp\P!VPVVVVR7#)a Start a crawl job and wait for it to complete. Args: url: Target URL to start crawling from prompt: Optional prompt to guide the crawl exclude_paths: Patterns of URLs to exclude include_paths: Patterns of URLs to include max_discovery_depth: Maximum depth for finding new URLs sitemap: Sitemap usage mode ("only" | "include" | "skip") ignore_sitemap: Deprecated alias for sitemap ("skip" when true, "include" when false) ignore_query_parameters: Ignore URL parameters limit: Maximum pages to crawl crawl_entire_domain: Follow parent directory links allow_external_links: Follow external domain links allow_subdomains: Follow subdomains ignore_robots_txt: Whether to ignore robots.txt rules delay: Delay in seconds between scrapes max_concurrency: Maximum number of concurrent scrapes webhook: Webhook configuration for notifications scrape_options: Page scraping configuration regex_on_full_url: Apply includePaths/excludePaths regex to the full URL (including query parameters) instead of just the pathname deduplicate_similar_urls: Whether to deduplicate similar URLs during crawl (default: True) zero_data_retention: Whether to delete data after 24 hours poll_interval: Seconds between status checks timeout: Maximum seconds to wait for the entire crawl job to complete (None for no timeout) request_timeout: Timeout (in seconds) for each individual HTTP request, including pagination requests when fetching results. If there are multiple pages, each page request gets this timeout Returns: CrawlJob when job completes Raises: ValueError: If request is invalid Exception: If the crawl fails to start or complete TimeoutError: If timeout is reached rrr:rrrrrrrrrrrrrrrrrrnr)rrLrrt)r crawl_moduler,rW)rXr:rrrrrrrrrrrrrrrrrrrrrLrrnresolved_sitemaprequest_kwargsrs&&$$$$$$$$$$$$$$$$$$$$$$$ rAr,FirecrawlClient.crawl6sP@#  #(B)7vY  3 f  ]  ]  "#6  &'>   U  "#6  #$8   0  !2  U    w  n !2! " '(@# $ "#6 ;' *  '(8N9 %00!!    '+   rDc,<V^8dQhRS[RS[S[,RS[S[S[,,RS[S[S[,,RS[S[,RS[S[R,,RS[S[,RS[R S[S[,R S[R S[R S[R S[RS[S[,RS[S[,RS[S[S[S[3,,RS[S[,RS[RS[RS[RS[S[,RS[ /#)r9r:rrrrrrrrrrrrrrrrrrrrnr;r) r=rrrPrr>rrr r)r?r@s"rArBrCsdWCWC WC WC  S * WC  S * WC&c]WC'";<=WC!WC"&WC}WC"WC#WCWC WC }!WC""##WC$%] 234%WC&!/'WC( )WC*#'+WC,"-WC.c]/WC0 1WCrDc TpVfVe V'dRMRp/RVbRVbRVbRVbRVbRVbR V bR V bR V bR V bR V bRVbRVbRVbRVbRVbRVbRVRV/CpVeVVR&\R/VBp\P!VPV4#)ac Start an asynchronous crawl job. Args: url: Target URL to start crawling from prompt: Optional prompt to guide the crawl exclude_paths: Patterns of URLs to exclude include_paths: Patterns of URLs to include max_discovery_depth: Maximum depth for finding new URLs sitemap: Sitemap usage mode ("only" | "include" | "skip") ignore_sitemap: Deprecated alias for sitemap ("skip" when true, "include" when false) ignore_query_parameters: Ignore URL parameters limit: Maximum pages to crawl crawl_entire_domain: Follow parent directory links allow_external_links: Follow external domain links allow_subdomains: Follow subdomains ignore_robots_txt: Whether to ignore robots.txt rules delay: Delay in seconds between scrapes max_concurrency: Maximum number of concurrent scrapes webhook: Webhook configuration for notifications scrape_options: Page scraping configuration regex_on_full_url: Apply includePaths/excludePaths regex to the full URL (including query parameters) instead of just the pathname deduplicate_similar_urls: Whether to deduplicate similar URLs during crawl (default: True) zero_data_retention: Whether to delete data after 24 hours Returns: CrawlResponse with job information Raises: ValueError: If request is invalid Exception: If the crawl operation fails to start rrr:rrrrrrrrrrrrrrrrrrnrrt)rr start_crawlrW)rXr:rrrrrrrrrrrrrrrrrrrrnrrrs&&$$$$$$$$$$$$$$$$$$$$ rArFirecrawlClient.start_crawlsAr#  #(B)7vY  3 f  ]  ]  "#6  &'>   U  "#6  #$8   0  !2  U    w  n !2! " '(@# $ "#6 ;' *  '(8N9 %00''(8(8'BBrDcR<V^8dQhRS[RS[S[,RS[S[,RS[/#)r9rpagination_configrr;)r=rr'rOr)r?r@s"rArBrCs=   $$45 "%    rDc J\P!VPVVVR7#)a Get the status of a crawl job. Args: job_id: ID of the crawl job pagination_config: Optional configuration for pagination behavior request_timeout: Timeout (in seconds) for each individual HTTP request. When auto-pagination is enabled (default) and there are multiple pages of results, this timeout applies to each page request separately, not to the entire operation Returns: CrawlJob with current status and data Raises: Exception: If the status check fails )rr)rget_crawl_statusrW)rXrrrs&&&$rAr FirecrawlClient.get_crawl_statuss).,,    /+   rDc<<V^8dQhRS[RS[S[,RS[/#)r9next_urlrr;)r=rrOr)r?r@s"rArBrCs-   "%    rDc H\P!VPVVR7#)z Fetch a single page of crawl results using a next URL. Args: next_url: Opaque next URL from a prior crawl status response request_timeout: Timeout (in seconds) for the HTTP request Returns: CrawlJob with the page data and next URL (if any) r)rget_crawl_status_pagerWrXrrs&&$rAr%FirecrawlClient.get_crawl_status_pages& 11    +  rDc&<V^8dQhRS[RS[/#r9crawl_idr;)r=r)r?r@s"rArBrC)s I I I1D IrDc D\P!VPV4#)z Retrieve error details and robots.txt blocks for a given crawl job. Args: crawl_id: The ID of the crawl job Returns: CrawlErrorsResponse containing per-URL errors and robots-blocked URLs )rget_crawl_errorsrWrXrs&&rAr FirecrawlClient.get_crawl_errors)s,,T-=-=xHHrDc <V^8dQhRS[/#r9r;r)r?r@s"rArBrC5s@@#7@rDc B\P!VP4#)zw Get a list of currently active crawl jobs. Returns: ActiveCrawlsResponse containing a list of active crawl jobs. )rget_active_crawlsrWrXs&rAr!FirecrawlClient.get_active_crawls5s--d.>.>??rDc <V^8dQhRS[/#rr)r?r@s"rArBrC>s((3(rDc "VP4#)z List currently active crawl jobs for the authenticated team. Returns: ActiveCrawlsResponse containing the list of active crawl jobs )rrs&rA active_crawlsFirecrawlClient.active_crawls>s%%''rDr.include_subdomainsc<V^8dQhRS[RS[S[,RS[S[,RS[S[,RS[S[,RS[S[R ,,RS[S[,RS[S[,R S[S[,R S[/ #) r9r:r.rrrrrLrnrdr;r)r=rr>rPrr&r)r?r@s"rArBrCGs&>&> &> &> %TN &> "*$ &>}&>'";<=&>#&>c]&>8$&> &>rDc  \;QJd RW#WEWgW34F 'gK RM RM!RW#WEWgW344'd\TTTTVeTMRVVV R7MRp \P!VPW4#)aMap a URL and return discovered links. Args: url: Root URL to explore search: Optional substring filter for discovered links include_subdomains: Whether to include subdomains ignore_query_parameters: Whether to ignore query parameters when mapping limit: Maximum number of links to return sitemap: Sitemap usage mode ("only" | "include" | "skip") timeout: Request timeout in milliseconds Returns: MapData containing the discovered links c3("TFqRJxK R#5irsrtrus& rArx&FirecrawlClient.map..ksO)N1$)NrzTFNr)r.rrrrrLrnrd)r{r map_moduler/rW) rXr:r.rrrrrLrnrdrs &&$$$$$$$$ rAr/FirecrawlClient.mapGsHSOE\elxC)NOSSSOE\elxC)NOOO1$;&2G #  UY ~~d..==rDc&<V^8dQhRS[RS[/#rr<)r?r@s"rArBrCos E ES ET ErDc D\P!VPV4#)z Cancel a crawl job. Args: crawl_id: The ID of the crawl job to cancel Returns: bool: True if the crawl was cancelled, False otherwise )r cancel_crawlrWrs&&rArFirecrawlClient.cancel_crawlos(()9)98DDrDc,<V^8dQhRS[RS[RS[/#)r9r:rr;)r=r)r?r@s"rArBrC{s' L L LS L_ LrDc \\WR7p\P!VPV4#)zDerive crawl parameters from natural-language prompt. Args: url: Root URL prompt: Instruction describing how to crawl Returns: CrawlParamsData with normalized crawl configuration )r:r)rrcrawl_params_previewrW)rXr:rrs&&& rAr$FirecrawlClient.crawl_params_preview{s'%<001A1A7KKrDschema system_promptenable_web_search show_sourcesr2c0<V^8dQhRS[S[S[,,RS[S[,RS[S[S[S[3,,RS[S[,RS[S[,RS[S[,RS[S[,RS[R ,R S[S[,R S[S[,R S[S[,/ #) r9urlsrrrrrrrr rrnr2)rrr=rrr>r()r?r@s"rArBrCs2 2 tCy!2  2 c3h( 2  } 2 'tn2 $D>2 tn2 !12 &d^2 c]2  %2 rDc  Z\P!VPVVVVVVVVV V V R7 #)aStart an extract job (non-blocking). .. deprecated:: The extract endpoint is in maintenance mode and its use is discouraged. Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement. Args: urls: URLs to extract from (optional) prompt: Natural-language instruction for extraction schema: Target JSON schema for the output system_prompt: Optional system instruction allow_external_links: Allow hyperlinks in output enable_web_search: Whether to augment with web search show_sources: Include per-field/source mapping when available scrape_options: Scrape options applied prior to extraction ignore_invalid_urls: Skip invalid URLs instead of failing integration: Integration tag/name agent: Agent configuration Returns: Response payload with job id/status (poll with get_extract_status) ) rrrrrrrrrnr2)extract_module start_extractrW) rXrrrrrrrrrrnr2s &&$$$$$$$$$$rAr FirecrawlClient.start_extractsBJ++    '!5/%) 3#  rDcL<V^8dQhRS[S[S[,,RS[S[,RS[S[S[S[3,,RS[S[,RS[S[,RS[S[,RS[S[,RS[R ,R S[S[,R S[R S[S[,R S[S[,RS[S[,/ #)r9rrrrrrrrr rrrLrnr2)rrr=rrr>rPr()r?r@s"rArBrCs8 8 tCy!8  8 c3h( 8  } 8 'tn8 $D>8 tn8 !18 &d^8 8 #8 c]8  %8 rDc  ^\P!VPVVVVVVVVV V V V V R7#)aExtract structured data and wait until completion. .. deprecated:: The extract endpoint is in maintenance mode and its use is discouraged. Review https://docs.firecrawl.dev/developer-guides/usage-guides/choosing-the-data-extractor to find a replacement. Args: urls: URLs to extract from (optional) prompt: Natural-language instruction for extraction schema: Target JSON schema for the output system_prompt: Optional system instruction allow_external_links: Allow hyperlinks in output enable_web_search: Whether to augment with web search show_sources: Include per-field/source mapping when available scrape_options: Scrape options applied prior to extraction ignore_invalid_urls: Skip invalid URLs instead of failing poll_interval: Seconds between status checks timeout: Maximum seconds to wait (None for no timeout) integration: Integration tag/name agent: Agent configuration Returns: Final extract response when completed ) rrrrrrrrrrLrnr2)r r1rW)rXrrrrrrrrrrrLrnr2s&&$$$$$$$$$$$$rAr1FirecrawlClient.extractsHR%%    '!5/%) 3'#  rD append_to_ididempotency_keyc7.<V^8dQhRS[S[,RS[S[R,,RS[S[S[S[3,,RS[S[S[,,RS[S[S[,,RS[S[,RS[S[,R S[S[,R S[S[,R S[S[S[S[,S[S[S[S[3,,3,,R S[S[S[R,,,R S[R,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[S[S[3,,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,/#)r9rr[rr\r]r^r_rLr`rarbrcrdr&rerfrgrhrirjrkrlrrrrrrnrrp rr=rrr>rPrrr)r?r@s"rArBrCsd d 3id $~./ d $sCx.) d tCy) d tCy)d $D>d #d 3-d d %S 4c9n0E+F FGHd $u&{ |}~d :&d  (~d 'tn!d "D>#d $3-%d &D>'d (})d *#+d ,!-d .%] 234/d 0sm1d 2&d^3d 4"#5d 6&d^7d 8c]9d :"#;d rDc \;QJd(RW#WEWgWWWWVVVVV34F 'gK RM RM!RW#WEWgWWWWVVVVV344'dv\R/\R/RVbRVbRVbRVbRVbR VbR VbR V bR V bR V bRV bRV bRVbRVbRVbRVbRVbRVbRVbP4UUu/uFwppVfK VVbK uppBMRp\P !VP VVVVVVVVVR7 #uuppi)a'Start a batch scrape job over multiple URLs (non-blocking). Args: urls: List of URLs to scrape formats: Output formats to collect per URL headers: HTTP headers include_tags: HTML tags to include exclude_tags: HTML tags to exclude only_main_content: Restrict scraping to main content timeout: Per-request timeout in milliseconds wait_for: Wait condition in milliseconds mobile: Emulate mobile viewport parsers: Parser list (e.g., ["pdf"]) actions: Browser actions to perform location: Location settings skip_tls_verification: Skip TLS verification remove_base64_images: Remove base64 images from output fast_mode: Prefer faster scraping modes use_mock: Use a mock data source (internal/testing) block_ads: Block ads during scraping proxy: Proxy setting max_age: Cache max age store_in_cache: Whether to store results in cache webhook: Webhook configuration append_to_id: Append to an existing batch job ignore_invalid_urls: Skip invalid URLs without failing max_concurrency: Max concurrent scrapes zero_data_retention: Delete data after 24 hours integration: Integration tag/name idempotency_key: Header used to deduplicate starts Returns: Response payload with job id (poll with get_batch_scrape_status) c3("TFqRJxK R#5irsrtrus& rArx5FirecrawlClient.start_batch_scrape..MO)N1$)NrzTFr[r\r]r^r_rLr`rarbrcrdrerfrgrhrirjrkrlN)rrrrrrrnrrt)r{r r|r} batch_modulestart_batch_scraperW)rXrr[r\r]r^r_rLr`rarbrcrdrerfrgrhrirjrkrlrrrrrrnrrrwrs&&$$$$$$$$$$$$$$$$$$$$$$$$$$ rAr"FirecrawlClient.start_batch_scrapesnSOrrr)r?r@s"rArBrCs# # tCy!#  #  # c] # c]# #+4.#  =>?# %%7 789# rDc  T\P!VPVVVVVVVVR7 #)aStart an agent job (non-blocking). Args: urls: URLs to process (optional) prompt: Natural-language instruction for the agent schema: Target JSON schema for the output (dict or Pydantic BaseModel) integration: Integration tag/name max_credits: Maximum credits to use (optional) model: Model to use for the agent ("spark-1-pro" or "spark-1-mini") webhook: Webhook URL or configuration for notifications Returns: Response payload with job id/status (poll with get_agent_status) )rrrnr0r1r2r) agent_module start_agentrW) rXrrrrnr0r1r2rs &&$$$$$$$rAr8FirecrawlClient.start_agents82''    ##%=  rDc <V^8dQhRS[S[S[,,RS[RS[S[,RS[S[,RS[RS[S[,RS[S[,RS[S[,R S[S[R ,,R S[S[S[S[3,,/ #) r9rrrrnrrLr0r1r2rr4r5)r?r@s"rArBrCs) ) tCy!)  )  ) c] ) ) #) c]) #+4.)  =>?) %%7 789) rDc  X\P!VPVVVVVVVVV V R7 #)aPRun an agent and wait until completion. Args: urls: URLs to process (optional) prompt: Natural-language instruction for the agent schema: Target JSON schema for the output (dict or Pydantic BaseModel) integration: Integration tag/name poll_interval: Seconds between status checks timeout: Maximum seconds to wait (None for no timeout) max_credits: Maximum credits to use (optional) model: Model to use for the agent ("spark-1-pro" or "spark-1-mini") webhook: Webhook URL or configuration for notifications Returns: Final agent response when completed ) rrrnrrLr0r1r2r)r7r2rW) rXrrrrnrrLr0r1r2rs &&$$$$$$$$$rAr2FirecrawlClient.agents>:!!    #'#%=  rDc <V^8dQhRS[/#rr)r?r@s"rArBrCs G Gs GrDc D\P!VPV4#)zGet the current status (and data if completed) of an agent job. Args: job_id: Agent job ID Returns: Agent response payload with status and optional data )r7get_agent_statusrWrs&&rAr? FirecrawlClient.get_agent_statuss,,T-=-=vFFrDc&<V^8dQhRS[RS[/#r#r<)r?r@s"rArBrCs C C3 C4 CrDc D\P!VPV4#)zjCancel a running agent job. Args: job_id: Agent job ID Returns: True if the agent was cancelled )r7 cancel_agentrWrs&&rArCFirecrawlClient.cancel_agents(()9)96BBrDc B\P!VP4#)zCGet current concurrency and maximum allowed for this team/key (v2).) usage_methodsget_concurrencyrWrs&rArGFirecrawlClient.get_concurrency,,T-=-=>>rDc B\P!VP4#)z-Get remaining credits for this team/key (v2).)rFget_credit_usagerWrs&rArK FirecrawlClient.get_credit_usage--d.>.>??rDc B\P!VP4#)z$Get recent token usage metrics (v2).)rFget_token_usagerWrs&rArOFirecrawlClient.get_token_usagerIrDc <V^8dQhRS[/#r9 by_api_keyr>)r?r@s"rArBrCsWWdWrDc D\P!VPV4#)z!Get historical credit usage (v2).)rFget_credit_usage_historicalrWrXrSs&&rArV+FirecrawlClient.get_credit_usage_historicals889I9I:VVrDc <V^8dQhRS[/#rRrT)r?r@s"rArBrC!sVVTVrDc D\P!VPV4#)z Get historical token usage (v2).)rFget_token_usage_historicalrWrWs&&rAr[*FirecrawlClient.get_token_usage_historical!s778H8H*UUrDc B\P!VP4#)z*Get metrics about the team's scrape queue.)rFget_queue_statusrWrs&rAr^ FirecrawlClient.get_queue_status%rMrDttl activity_ttlstream_web_viewc <V^8dQhRS[S[,RS[S[,RS[S[,RS[S[S[S[3,,/#)r9r`rarbrm)rrPr>rr=r)r?r@s"rArBrC*sN  c] sm  "$  $sCx.)  rDc L\P!VPVVVVR7#)aCreate a new browser session. Args: ttl: Total time-to-live in seconds (30-3600, default 300) activity_ttl: Inactivity TTL in seconds (10-3600) stream_web_view: Whether to enable webview streaming profile: Profile config with ``name`` (str) and optional ``save_changes`` (bool, default ``True``) Returns: BrowserCreateResponse with session id and CDP URL )r`rarbrm)browser_moduler3rW)rXr`rarbrms&$$$$rAr3FirecrawlClient.browser*s,(%%   %+   rDrc P<V^8dQhRS[RS[RS[R,RS[S[,/#)r9 session_idrrrLr)r=rrrP)r?r@s"rArBrCFs=    23  #  rDc L\P!VPVVVVR7#)a!Execute code in a browser session. Args: session_id: Browser session ID code: Code to execute language: Programming language ("python", "node", or "bash") timeout: Execution timeout in seconds (1-300, default 30) Returns: BrowserExecuteResponse with execution result )rrL)rebrowser_executerW)rXrhrrrLs&&&$$rArjFirecrawlClient.browser_executeFs,&--        rDc <V^8dQhRS[/#)r9rhr)r?r@s"rArBrCas K K KrDc D\P!VPV4#)zhDelete a browser session. Args: session_id: Browser session ID Returns: BrowserDeleteResponse )redelete_browserrW)rXrhs&&rArnFirecrawlClient.delete_browseras,,T-=-=zJJrDstatusc><V^8dQhRS[S[R,,/#)r9rp)active destroyed)rr)r?r@s"rArBrCls"  !678 rDc F\P!VPVR7#)zList browser sessions. Args: status: Filter by session status ("active" or "destroyed") Returns: BrowserListResponse with list of sessions )rp)re list_browsersrW)rXrps&$rAruFirecrawlClient.list_browsersls#++     rDkindr,c V<V^8dQhRS[RS[R,RS[RS[S[,RS[/#)r9rrwrrLr;)r,r-)r=rrPrr5)r?r@s"rArBrC~sN^^^&' ^  ^ # ^ ^rDc \WW#VR7#)aCreate a watcher for crawl or batch jobs. Args: job_id: Job ID to watch kind: Job kind ("crawl" or "batch") poll_interval: Seconds between status checks timeout: Maximum seconds to watch (None for no timeout) Returns: Watcher instance )rwrrLr4)rXrrwrrLs&&$$$rAwatcherFirecrawlClient.watcher~s&t$U\]]rD wait_timeoutc;J<V^8dQhRS[S[,RS[S[R,,RS[S[S[S[3,,RS[S[S[,,RS[S[S[,,RS[S[,RS[S[,R S[S[,R S[S[,R S[S[S[S[,S[S[S[S[3,,3,,R S[S[S[R ,,,R S[R,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[S[S[3,,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[S[,RS[RS[S[,/#)!r9rr[rr\r]r^r_rLr`rarbrcrdr&rerfrgrhrirjrkrlrrrrrrnrrr|rpr)r?r@s"rArBrCsI I 3iI $~./ I $sCx.) I tCy) I tCy)I $D>I #I 3-I I %S 4c9n0E+F FGHI $u&{ |}~I :&I  (~I 'tn!I "D>#I $3-%I &D>'I (})I *#+I ,!-I .%] 234/I 0sm1I 2&d^3I 4"#5I 6&d^7I 8c]9I :"#;I <=I >sm?I rDc \;QJd(RW#WEWgWWWWVVVVV34F 'gK RM RM!RW#WEWgWWWWVVVVV344'dv\R/\R/RVbRVbRVbRVbRVbR VbR VbR V bR V bR V bRV bRV bRVbRVbRVbRVbRVbRVbRVbP4UUu/uFwppVfK VVbK uppBMRp \P !VP VV VVVVVVVVVR7 #uuppi)z5 Start a batch scrape job and wait until completion. c3("TFqRJxK R#5irsrtrus& rArx/FirecrawlClient.batch_scrape..rrzTFr[r\r]r^r_rLr`rarbrcrdrerfrgrhrirjrkrlN) rrrrrrrnrrrLrt)r{r r|r}r batch_scraperW)!rXrr[r\r]r^r_rLr`rarbrcrdrerfrgrhrirjrkrlrrrrrrnrrr|rrwrs!&&$$$$$$$$$$$$$$$$$$$$$$$$$$$$ rArFirecrawlClient.batch_scrapestSO!% &> .2 &> 37 &> $&>AE&>"&&>&*&>(,&>&>P E E L L2 !% 2 ,0 2 (, 2 042 -12 (,2 592 /32 &*2 )-2 2 h8 !% 8 ,0 8 (, 8 048 -18 (,8 598 /38 8 "&8 &*8 )-8 8 td 37 d -1 d -1 d -1d -1d "&d #'d "&d LPd AEd *.d 15d 04!d "%)#d $#'%d &%)'d ( $)d *"&+d ,*.-d .8'+?I I I rDr7)FrrStypingrrrrrrrtypesr r r r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(utils.http_clientr)utils.error_handlerr*methodsr+r~r,rr-rr.rr/rr)r0rFr1r r2r7r3rerzr5r7rtrDrArs{  FFF!!!!!!!!!D*/,**,&++.*.c c rD