> ## Documentation Index
> Fetch the complete documentation index at: https://skyvern.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a session

> Get details about a specific browser session, including the browser address for cdp connection.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/browser_sessions/{browser_session_id}
openapi: 3.1.0
info:
  title: Skyvern API
  description: API for Skyvern
  version: 1.0.0
servers:
  - url: https://api.skyvern.com
    x-fern-server-name: Cloud
  - url: https://api-staging.skyvern.com
    x-fern-server-name: Staging
  - url: http://localhost:8000
    x-fern-server-name: Local
security: []
paths:
  /v1/browser_sessions/{browser_session_id}:
    get:
      tags:
        - Browser Sessions
      summary: Get a session
      description: >-
        Get details about a specific browser session, including the browser
        address for cdp connection.
      operationId: get_browser_session_v1_browser_sessions__browser_session_id__get
      parameters:
        - name: browser_session_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              The ID of the browser session. browser_session_id starts with
              `pbs_`
            examples:
              - pbs_123456
            title: Browser Session Id
          description: The ID of the browser session. browser_session_id starts with `pbs_`
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Skyvern API key for authentication. API key can be found at
              https://app.skyvern.com/settings.
            title: X-Api-Key
          description: >-
            Skyvern API key for authentication. API key can be found at
            https://app.skyvern.com/settings.
      responses:
        '200':
          description: Successfully retrieved browser session details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrowserSessionResponse'
        '403':
          description: Unauthorized - Invalid or missing authentication
        '404':
          description: Browser session not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    BrowserSessionResponse:
      properties:
        browser_session_id:
          type: string
          title: Browser Session Id
          description: >-
            Unique identifier for the browser session. browser_session_id starts
            with `pbs_`.
          examples:
            - pbs_123456
        organization_id:
          type: string
          title: Organization Id
          description: ID of the organization that owns this session
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          description: Current status of the browser session
          examples:
            - created
            - running
            - completed
            - failed
            - timeout
        runnable_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Runnable Type
          description: >-
            Type of the current runnable associated with this session (workflow,
            task etc)
          examples:
            - task
            - workflow_run
        runnable_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Runnable Id
          description: ID of the current runnable
          examples:
            - tsk_123456
            - wr_123456
        timeout:
          anyOf:
            - type: integer
            - type: 'null'
          title: Timeout
          description: >-
            Timeout in minutes for the session. Timeout is applied after the
            session is started. Defaults to 60 minutes.
          examples:
            - 60
            - 120
        browser_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Browser Address
          description: Url for connecting to the browser
          examples:
            - http://localhost:9222
            - https://3.12.10.11/browser/123456
        app_url:
          anyOf:
            - type: string
            - type: 'null'
          title: App Url
          description: Url for the browser session page
          examples:
            - https://app.skyvern.com/browser-session/pbs_123456
        extensions:
          anyOf:
            - items:
                $ref: '#/components/schemas/Extensions'
              type: array
            - type: 'null'
          title: Extensions
          description: A list of extensions installed in the browser session.
        browser_type:
          anyOf:
            - $ref: '#/components/schemas/PersistentBrowserType'
            - type: 'null'
          description: The type of browser used for the session.
        browser_profile_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Browser Profile Id
          description: >-
            ID of the browser profile loaded into this session, if any.
            browser_profile_id starts with `bp_`.
        generate_browser_profile:
          type: boolean
          title: Generate Browser Profile
          description: >-
            Whether this session's browser profile will be saved when it ends so
            it can become a reusable browser profile.
          default: false
        vnc_streaming_supported:
          type: boolean
          title: Vnc Streaming Supported
          description: Whether the browser session supports VNC streaming
          default: false
        download_path:
          anyOf:
            - type: string
            - type: 'null'
          title: Download Path
          description: The path where the browser session downloads files
        downloaded_files:
          anyOf:
            - items:
                $ref: '#/components/schemas/FileInfo'
              type: array
            - type: 'null'
          title: Downloaded Files
          description: The list of files downloaded by the browser session
        recordings:
          anyOf:
            - items:
                $ref: '#/components/schemas/FileInfo'
              type: array
            - type: 'null'
          title: Recordings
          description: The list of video recordings from the browser session
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: Timestamp when the session was started
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
          description: Timestamp when the session was completed
        created_at:
          type: string
          format: date-time
          title: Created At
          description: >-
            Timestamp when the session was created (the timestamp for the
            initial request)
        modified_at:
          type: string
          format: date-time
          title: Modified At
          description: Timestamp when the session was last modified
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deleted At
          description: Timestamp when the session was deleted, if applicable
      type: object
      required:
        - browser_session_id
        - organization_id
        - created_at
        - modified_at
      title: BrowserSessionResponse
      description: Response model for browser session information.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Extensions:
      type: string
      enum:
        - ad-blocker
        - captcha-solver
      title: Extensions
    PersistentBrowserType:
      type: string
      enum:
        - msedge
        - chrome
        - stealth-chromium
      title: PersistentBrowserType
    FileInfo:
      properties:
        url:
          type: string
          title: Url
          description: URL to access the file
        checksum:
          anyOf:
            - type: string
            - type: 'null'
          title: Checksum
          description: SHA-256 checksum of the file
        filename:
          anyOf:
            - type: string
            - type: 'null'
          title: Filename
          description: Original filename
        file_size:
          anyOf:
            - type: integer
            - type: 'null'
          title: File Size
          description: Size of the file in bytes
        modified_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Modified At
          description: Modified time of the file
        artifact_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Artifact Id
          description: Artifact row id for refresh-on-read
      type: object
      required:
        - url
      title: FileInfo
      description: Information about a downloaded file, including URL and checksum.
    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

````