API Evangelist conversational phrasing for Browser Use Workspaces API

# 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 Workspaces API
  version: 1.0.0
extends: openapi/browser-use-workspaces-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: 9
- target: $.paths['/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List my workspaces
      effect: read
      questions:
      - Which shared file workspaces exist in my project?
      - Can I page through my workspaces?
      instructions:
      - text: List all my workspaces.
      - text: Show page {page} of my workspaces, {size} per page.
        slots:
          page: query.pageNumber
          size: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace for shared file storage
      effect: write
      questions:
      - How do I keep files available to the agent across multiple sessions?
      - Can I set up persistent storage that several sessions share?
      instructions:
      - text: Create a workspace called {name}.
        slots:
          name: requestBody.name
      - text: Set up a new persistent workspace named {name} for my agent's files.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspace_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace's details
      effect: read
      questions:
      - What are the details of a specific workspace?
      - Can I look up one workspace by its ID?
      instructions:
      - text: Show the details of workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Get workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspace_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workspace and all its files
      effect: destructive
      questions:
      - How do I delete a whole workspace including everything stored in it?
      - Does removing a workspace also erase its stored data?
      instructions:
      - text: Delete workspace {workspace_id} and all of its stored data.
        slots:
          workspace_id: path.workspace_id
      - text: Tear down the workspace {workspace_id} completely.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspace_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a workspace
      effect: write
      questions:
      - Can I rename a workspace after creating it?
      - How do I change the name of an existing workspace?
      instructions:
      - text: Rename workspace {workspace_id} to {name}.
        slots:
          workspace_id: path.workspace_id
          name: requestBody.name
      - text: Change the name of workspace {workspace_id} to {name}.
        slots:
          workspace_id: path.workspace_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspace_id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in a workspace
      effect: read
      questions:
      - What files are stored in my workspace?
      - Can I list only the files under one folder of a workspace, without recursing into subfolders?
      instructions:
      - text: List the files in workspace {workspace_id} under {prefix}.
        slots:
          workspace_id: path.workspace_id
          prefix: query.prefix
      - text: 'Show files in workspace {workspace_id} with download URLs included: {urls}.'
        slots:
          workspace_id: path.workspace_id
          urls: query.includeUrls
      - text: List only the top level of folder {prefix} in workspace {workspace_id}, shallow {shallow}.
        slots:
          prefix: query.prefix
          workspace_id: path.workspace_id
          shallow: query.shallow
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspace_id}/files'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one file from a workspace
      effect: destructive
      questions:
      - How do I delete a single file from a workspace without removing the workspace?
      - Can I remove one stored file by its path?
      instructions:
      - text: Delete the file at {path} from workspace {workspace_id}.
        slots:
          path: query.path
          workspace_id: path.workspace_id
      - text: Remove {path} from workspace {workspace_id}.
        slots:
          path: query.path
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspace_id}/size'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a workspace's storage usage
      effect: read
      questions:
      - How much storage is a workspace using right now?
      - Is my workspace getting large?
      instructions:
      - text: Show the current storage usage of workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Tell me how big workspace {workspace_id} is.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspace_id}/files/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Get upload URLs for files in a workspace
      effect: write
      questions:
      - How do I upload several files into a workspace at once?
      - Can I upload files into a specific folder of a workspace?
      instructions:
      - text: Get upload URLs to add {files} to workspace {workspace_id}.
        slots:
          files: requestBody.files
          workspace_id: path.workspace_id
      - text: Prepare uploads for {files} into folder {prefix} of workspace {workspace_id}.
        slots:
          files: requestBody.files
          prefix: query.prefix
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'