# BrowserOptions

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    BrowserOptions:
      type: object
      properties:
        session_name:
          type: string
          description: >-
            Set a name for your session to facilitate searching and viewing in
            the historical session list.
        session_ttl:
          type: string
          description: >-
            Controls the session duration and automatically closes the browser
            instance after timeout. Measured in seconds (s), defaults to 180
            seconds (3 minutes), customizable between 60 seconds (1 minute) and
            900 seconds (recommended maximum 15 minutes, but longer times can be
            set). Once the specified TTL is reached, the session will expire and
            Scraping Browser will close the browser instance to free resources.
        session_recording:
          type: string
          description: >-
            Whether to enable session recording. When enabled, the entire
            browser session execution process will be automatically recorded,
            and after the session is completed, it can be replayed and viewed in
            the historical session list details. Defaults to false.
        proxy_country:
          type: string
          description: >-
            Sets the target country/region for the proxy, sending requests via
            an IP address from that region. You can specify a country code
            (e.g., US for the United States, GB for the United Kingdom, ANY for
            any country). See country codes for all supported options.
        proxy_url:
          type: string
          description: >-
            Used to set the browser’s proxy URL, for example:
            http://user:pass@ip:port. If this parameter is set, all other
            proxy_* parameters will be ignored.


            - 💡Custom proxy functionality is currently only available to
            Enterprise and Enterprise Enhanced subscription users Upgrade Now

            - 💡Enterprise-level custom users can contact us to use custom
            proxies.
        fingerprint:
          type: string
          description: >-
            A browser fingerprint is a nearly unique “digital fingerprint”
            created using your browser and device configuration information,
            which can be used to track your online activity even without
            cookies. Fortunately, configuring fingerprints in Scraping Browser
            is optional. We offer deep customization of browser fingerprints,
            such as core parameters like browser user agent, time zone,
            language, and screen resolution, and support extending functionality
            through custom launch parameters. Suitable for multi-account
            management, data collection, and privacy protection scenarios, using
            scrapeless’s own Chromium browser completely avoids detection. By
            default, our Scraping Browser service generates a random fingerprint
            for each session. Reference
      x-apidog-orders:
        - session_name
        - session_ttl
        - session_recording
        - proxy_country
        - proxy_url
        - fingerprint
      x-apidog-folder: ''
  securitySchemes:
    apikey-header-x-api-token:
      type: apiKey
      in: header
      name: x-api-token
servers:
  - url: https://api.scrapeless.com
    description: Prod Env
security:
  - apikey-header-x-api-token: []

```
