> ## Documentation Index
> Fetch the complete documentation index at: https://browseruse-0aece648-cursor-proxy-indicator-and-text-6cda.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Session

> Stop a session and all its running tasks.



## OpenAPI

````yaml cloud/openapi/v2.json patch /sessions/{session_id}
openapi: 3.1.0
info:
  title: Browser Use Public API v2
  summary: Browser Use API for running web agents (v2)
  version: 2.0.0
servers:
  - url: https://api.browser-use.com/api/v2
    description: Production server
security: []
paths:
  /sessions/{session_id}:
    patch:
      tags:
        - Sessions
      summary: Update Session
      description: Stop a session and all its running tasks.
      operationId: update_session_sessions__session_id__patch
      parameters:
        - name: session_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Session Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSessionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionView'
        '404':
          description: Session not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionNotFoundError'
        '422':
          description: Request validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    UpdateSessionRequest:
      properties:
        action:
          $ref: '#/components/schemas/SessionUpdateAction'
          title: Action
          description: The action to perform on the session
      type: object
      required:
        - action
      title: UpdateSessionRequest
      description: Request model for updating session state.
    SessionView:
      properties:
        id:
          type: string
          format: uuid
          title: ID
          description: Unique identifier for the session
        status:
          $ref: '#/components/schemas/SessionStatus'
          title: Status
          description: Current status of the session (active/stopped)
        liveUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Live URL
          description: URL where the browser can be viewed live in real-time
        recordingUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Recording URL
          description: >-
            Presigned URL to download the session recording (available after
            session ends, if recording was enabled)
        startedAt:
          type: string
          format: date-time
          title: Started At
          description: Timestamp when the session was created and started
        finishedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
          description: Timestamp when the session was stopped (None if still active)
        tasks:
          items:
            $ref: '#/components/schemas/TaskItemView'
          type: array
          title: Tasks
          description: List of tasks associated with this session
        publicShareUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Public Share URL
          description: Optional URL to access the public share of the session
        persistMemory:
          type: boolean
          title: Persist Memory
          description: >-
            Whether tasks in this session share memory and history with each
            other
          default: true
        keepAlive:
          type: boolean
          title: Keep Alive
          description: Whether the browser session stays alive after tasks complete
          default: true
        proxyUsedMb:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Proxy Used MB
          description: Amount of proxy data used in MB
          default: '0'
        proxyCost:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Proxy Cost
          description: Cost of proxy usage in USD
          default: '0'
      type: object
      required:
        - id
        - status
        - startedAt
        - tasks
      title: SessionView
      description: >-
        View model for representing a (browser) session with its associated
        tasks.
    SessionNotFoundError:
      properties:
        detail:
          type: string
          title: Detail
          default: Session not found
      type: object
      title: SessionNotFoundError
      description: Error response when a session is not found
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SessionUpdateAction:
      type: string
      enum:
        - stop
      title: SessionUpdateAction
      description: |-
        Available actions that can be performed on a session

        Attributes:
            STOP: Stop the session and all its associated tasks (cannot be undone)
    SessionStatus:
      type: string
      enum:
        - active
        - stopped
      title: SessionStatus
      description: |-
        Enumeration of possible agent session states

        Attributes:
            ACTIVE: Agent session is currently active and running
            STOPPED: Agent session has been stopped and is no longer active
    TaskItemView:
      properties:
        id:
          type: string
          format: uuid
          title: ID
          description: Unique identifier for the task
        sessionId:
          type: string
          format: uuid
          title: Session ID
          description: ID of the session this task belongs to
        llm:
          type: string
          title: LLM
          description: The LLM model used for this task represented as a string
        task:
          type: string
          title: Task
          description: The task prompt/instruction given to the agent
        status:
          $ref: '#/components/schemas/TaskStatus'
        createdAt:
          type: string
          format: date-time
          title: Created At
          description: Naive UTC timestamp when the task was created
        startedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: >-
            Naive UTC timestamp when the task was started (None if task has not
            started yet)
        finishedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
          description: Naive UTC timestamp when the task completed (None if still running)
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          description: >-
            Optional additional metadata associated with the task set by the
            user
          default: {}
        output:
          anyOf:
            - type: string
            - type: 'null'
          title: Output
          description: Final output/result of the task
        browserUseVersion:
          anyOf:
            - type: string
            - type: 'null'
          title: Browser Use Version
          description: >-
            Version of browser-use used for this task (older tasks may not have
            this set)
        isSuccess:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Success
          description: Whether the task was successful (self-reported by the agent)
        judgement:
          anyOf:
            - type: string
            - type: 'null'
          title: Judgement
          description: Stringified JSON object containing the full report from the judge
        judgeVerdict:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Judge Verdict
          description: >-
            Judge verdict - True if the judge found the task to be successful,
            False otherwise (None if judge is not enabled)
        cost:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Cost
          description: >-
            Total cost of the task in USD. This is the sum of all step costs
            incurred during task execution.
        suggestions:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Suggestions
          description: >-
            List of actionable suggestions for improving task configuration
            based on detected issues during execution.
      type: object
      required:
        - id
        - sessionId
        - llm
        - task
        - status
        - createdAt
      title: TaskItemView
      description: View model for representing a task with its execution details
    TaskStatus:
      type: string
      enum:
        - created
        - started
        - finished
        - stopped
      title: TaskStatus
      description: |-
        Enumeration of possible task execution states

        Attributes:
                CREATED: Task has been created but not yet started.
            STARTED: Task has been started and is currently running.
            FINISHED: Task has finished and the agent has completed the task.
            STOPPED: Task execution has been manually stopped (cannot be resumed).
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-Browser-Use-API-Key

````