Browser Use · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Browser Use Browsers API

6 actions 6 updates phrasing extends openapi/browser-use-browsers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Browser Use's API. It is a proposal applied on top of the contract, not a document Browser Use publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/browsers'].get
$.paths['/browsers'].post
$.paths['/browsers/{session_id}'].get
$.paths['/browsers/{session_id}'].patch
$.paths['/browsers/{session_id}/downloads'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Browser Use Browsers API
  version: 1.0.0
extends: openapi/browser-use-browsers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/browsers'].get
  update:
    x-apievangelist-phrasing:
      intent: List my raw browser sessions
      effect: read
      questions:
      - Which standalone browser sessions have I started, and what state are they in?
      - Can I filter my browser sessions by status or page through them?
      - Is there a way to find the browser sessions tied to a particular agent session?
      instructions:
      - text: List my browser sessions filtered to {status}.
        slots:
          status: query.filterBy
      - text: Show page {page} of my browser sessions, {size} per page.
        slots:
          page: query.pageNumber
          size: query.pageSize
      - text: List the browser sessions linked to agent session {agent_session}.
        slots:
          agent_session: query.agentSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/browsers'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new cloud browser session
      effect: write
      questions:
      - How do I spin up a remote cloud browser I can drive myself without an AI agent?
      - Can I launch a browser with a proxy in a specific country and a custom screen size?
      - What does a browser session cost per hour, and is unused time refunded?
      instructions:
      - text: Start a browser session using profile {profile} with a proxy in {country}.
        slots:
          profile: requestBody.profileId
          country: requestBody.proxyCountryCode
      - text: Launch a browser session with recording {recording} that times out after {minutes} minutes.
        slots:
          minutes: requestBody.timeout
          recording: requestBody.enableRecording
      - text: Open a new cloud browser at {width} by {height} pixels.
        slots:
          width: requestBody.browserScreenWidth
          height: requestBody.browserScreenHeight
      method: generated
      generated: '2026-09-26'
- target: $.paths['/browsers/{session_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a browser session's status and URLs
      effect: read
      questions:
      - How can I get the live view or CDP URL for a browser session I started?
      - Is my standalone browser session still running or has it stopped?
      instructions:
      - text: Show the status and connection URLs for browser session {session_id}.
        slots:
          session_id: path.session_id
      - text: Get the recording and details of browser session {session_id}.
        slots:
          session_id: path.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/browsers/{session_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Stop a browser session and refund unused time
      effect: destructive
      questions:
      - How do I shut down a cloud browser session I no longer need?
      - If I stop a browser session early, do I get refunded for the unused time?
      instructions:
      - text: Stop browser session {session_id} so the unused time is refunded.
        slots:
          session_id: path.session_id
      - text: Apply the {action} action to browser session {session_id}.
        slots:
          action: requestBody.action
          session_id: path.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/browsers/{session_id}/downloads'].get
  update:
    x-apievangelist-phrasing:
      intent: List files a browser session downloaded
      effect: read
      questions:
      - What files did the cloud browser download during my session?
      - Can I get download links for the files a browser session saved, and how long do they last?
      instructions:
      - text: 'List the downloads from browser session {session_id}, include presigned URLs: {urls}.'
        slots:
          session_id: path.session_id
          urls: query.includeUrls
      - text: Show the next {limit} downloaded files for browser session {session_id} after cursor {cursor}.
        slots:
          limit: query.limit
          session_id: path.session_id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'