# 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 Profiles API
  version: 1.0.0
extends: openapi/browser-use-profiles-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['/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search browser profiles
      effect: read
      questions:
      - Which saved browser profiles do I have in my project?
      - Can I search profiles by name or by the user ID I assigned to them?
      instructions:
      - text: Find the browser profile for user {query}.
        slots:
          query: query.query
      - text: List my browser profiles, page {page} with {size} per page.
        slots:
          page: query.pageNumber
          size: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a browser profile to keep logins
      effect: write
      questions:
      - How do I keep an agent logged in to a site between tasks?
      - Can I tag a new browser profile with my own internal user ID?
      instructions:
      - text: Create a browser profile named {name} for user {user_id}.
        slots:
          name: requestBody.name
          user_id: requestBody.userId
      - text: Make a new profile so this customer's login state persists across tasks.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profiles/{profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a browser profile's details
      effect: read
      questions:
      - What name and user ID are attached to a particular browser profile?
      - Can I look up one specific browser profile by its ID?
      instructions:
      - text: Show the details of browser profile {profile_id}.
        slots:
          profile_id: path.profile_id
      - text: Look up profile {profile_id} and tell me which user it belongs to.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profiles/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a browser profile
      effect: destructive
      questions:
      - How do I remove a saved browser profile and its stored login state?
      - Is deleting a browser profile permanent?
      instructions:
      - text: Delete browser profile {profile_id} permanently.
        slots:
          profile_id: path.profile_id
      - text: Remove the profile {profile_id} for a user who closed their account.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/profiles/{profile_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a profile or change its user ID
      effect: write
      questions:
      - Can I rename an existing browser profile?
      - How do I change the user ID linked to a profile I already created?
      instructions:
      - text: Rename browser profile {profile_id} to {name}.
        slots:
          profile_id: path.profile_id
          name: requestBody.name
      - text: Set the user ID on existing profile {profile_id} to {user_id}.
        slots:
          profile_id: path.profile_id
          user_id: requestBody.userId
      method: generated
      generated: '2026-09-26'