provider.py 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. """Firecrawl cloud browser (``/v2/browser`` only; the web plugin under ``plugins/web/firecrawl/``
  2. shares ``FIRECRAWL_API_KEY``). Config ``browser.cloud_provider: "firecrawl"`` (explicit only — not
  3. in the legacy auto-detect walk). Env: ``FIRECRAWL_API_KEY``, ``FIRECRAWL_API_URL`` (default
  4. https://api.firecrawl.dev), ``FIRECRAWL_BROWSER_TTL`` (default 300 s)."""
  5. from __future__ import annotations
  6. import logging
  7. import os
  8. from typing import Any, Dict, Optional
  9. from agent.secret_scope import get_secret
  10. from plugins.browser._common import CloudBrowserProvider
  11. logger = logging.getLogger(__name__)
  12. _BASE_URL = "https://api.firecrawl.dev"
  13. class FirecrawlBrowserProvider(CloudBrowserProvider):
  14. """Firecrawl (https://firecrawl.dev) cloud browser backend."""
  15. provider_id = "firecrawl"
  16. label = "Firecrawl"
  17. release_method = "delete"
  18. release_path = "/v2/browser/{session_id}"
  19. create_label_suffix = " browser"
  20. setup_tag = "Cloud browser with remote execution"
  21. setup_env_vars = [
  22. {"key": "FIRECRAWL_API_KEY", "prompt": "Firecrawl API key", "url": "https://firecrawl.dev"},
  23. ]
  24. def _api_url(self) -> str:
  25. # Per-profile like the key: the scoped key must not be sent to the default profile's endpoint.
  26. return get_secret("FIRECRAWL_API_URL", "") or _BASE_URL
  27. def _get_config_or_none(self) -> Optional[dict[str, Any]]:
  28. return {"base_url": self._api_url()} if get_secret("FIRECRAWL_API_KEY") else None
  29. def _get_config(self) -> dict[str, Any]:
  30. # Never raises: a missing key surfaces from _headers() inside the request try-block, so
  31. # close_session logs it as an exception (legacy behaviour).
  32. return {"base_url": self._api_url()}
  33. def _headers(self, config: Optional[dict[str, Any]] = None) -> dict[str, str]:
  34. api_key = get_secret("FIRECRAWL_API_KEY")
  35. if not api_key:
  36. raise ValueError(
  37. "FIRECRAWL_API_KEY environment variable is required. "
  38. "Get your key at https://firecrawl.dev")
  39. return {"Content-Type": "application/json", "Authorization": f"Bearer {api_key}"}
  40. def create_session(self, task_id: str) -> dict[str, object]:
  41. try:
  42. ttl = int(os.environ.get("FIRECRAWL_BROWSER_TTL", "300"))
  43. except (ValueError, TypeError):
  44. ttl = 300
  45. response = self._post_create(f"{self._api_url()}/v2/browser", self._headers(), {"ttl": ttl})
  46. self._check_created(response)
  47. data = response.json()
  48. session_name = self._session_name(task_id)
  49. logger.info("Created Firecrawl browser session %s", session_name)
  50. return {
  51. "session_name": session_name,
  52. "bb_session_id": data["id"],
  53. "cdp_url": data["cdpUrl"],
  54. "features": {"firecrawl": True},
  55. }