Class APIRequestContext

py/selenium/webdriver/common/api_request_context.py:510–647

Makes HTTP requests with automatic browser cookie synchronization. Cookies from the browser session are sent with API requests, and cookies from API responses are synced back to the browser. Args: driver: The WebDriver instance to sync cookies with. base_url: Optional b

class APIRequestContext(_BaseRequestContext):
    """Makes HTTP requests with automatic browser cookie synchronization.

    Cookies from the browser session are sent with API requests, and cookies
    from API responses are synced back to the browser.

    Args:
        driver: The WebDriver instance to sync cookies with.
        base_url: Optional base URL prepended to relative request paths.
        extra_headers: Optional headers included in every request.
        timeout: Default request timeout in seconds.
        max_redirects: Maximum number of redirects to follow.
        fail_on_status_code: If True, raise APIRequestFailure for non-2xx responses.
    """

    def __init__(
        self,
        driver: "WebDriver",
        base_url: str = "",
        extra_headers: dict[str, str] | None = None,
        timeout: float = 30.0,
        max_redirects: int = 10,
        fail_on_status_code: bool = False,
    ) -> None:
        super().__init__(
            base_url=base_url,
            extra_headers=extra_headers,
            timeout=timeout,
            max_redirects=max_redirects,
            fail_on_status_code=fail_on_status_code,
        )
        self._driver = driver

    def new_context(
        self,
        base_url: str = "",
        extra_headers: dict[str, str] | None = None,
        storage_state: dict | str | pathlib.Path | None = None,
        fail_on_status_code: bool = False,
    ) -> "_IsolatedAPIRequestContext":
        """Create an isolated API request context that does not sync with the browser.

        Args:
            base_url: Optional base URL for this context.
            extra_headers: Optional headers for this context.
            storage_state: Optional cookies to pre-load, as a dict, JSON file path, or Path.
            fail_on_status_code: If True, raise APIRequestFailure for non-2xx responses.

        Returns:
            An _IsolatedAPIRequestContext instance.
        """
        cookies: list[dict] = []
        if storage_state is not None:
            if isinstance(storage_state, (str, pathlib.Path)):
                file_path = pathlib.Path(storage_state)
                if not file_path.exists():
                    raise FileNotFoundError(f"Storage state file not found: {file_path}")
                try: