# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Phantom Browser API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-phantom-browser-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 38
- target: $.paths['/api/phantom-browser/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List Phantom browser profiles
      effect: read
      questions:
      - Which Phantom browser profiles do I have set up?
      - Can I see every browser profile configured for the Phantom desktop client?
      instructions:
      - text: List all my Phantom browser profiles.
      - text: Show every Phantom profile in this workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Phantom browser profile
      effect: write
      questions:
      - How do I add a new browser profile for the Phantom client?
      - Can I create another Phantom browser profile for a separate identity?
      instructions:
      - text: Create a new Phantom browser profile.
      - text: Add a fresh Phantom profile to my workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Resync profiles to the Phantom client
      effect: write
      questions:
      - My Phantom desktop client is missing profiles, can I push the list to it again?
      - Is there a way to resend the profile list to the connected Phantom client?
      instructions:
      - text: Re-send my profile list to the connected Phantom client.
      - text: Sync Phantom profiles down to the desktop client now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Phantom browser profile
      effect: read
      questions:
      - What settings does a specific Phantom browser profile have?
      - Can I look up the details of a single Phantom profile by its id?
      instructions:
      - text: Show the details of Phantom profile {id}.
        slots:
          id: path.id
      - text: Fetch the configuration of browser profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Phantom browser profile
      effect: write
      questions:
      - Can I edit the settings of an existing Phantom browser profile?
      - How do I change a Phantom profile I already created?
      instructions:
      - text: Update the settings of Phantom profile {id}.
        slots:
          id: path.id
      - text: Save my changes to browser profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Phantom browser profile
      effect: destructive
      questions:
      - How do I remove a Phantom browser profile I no longer use?
      - Can I permanently get rid of one Phantom profile?
      instructions:
      - text: Delete Phantom browser profile {id}.
        slots:
          id: path.id
      - text: Remove profile {id} from my Phantom profiles.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/client/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Phantom desktop client connection
      effect: read
      questions:
      - Is my Phantom desktop client connected right now?
      - What is the connection status of the Phantom client app?
      instructions:
      - text: Check whether the Phantom desktop client is online.
      - text: Show the Phantom client connection status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/client/token/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate the Phantom client token
      effect: destructive
      questions:
      - How do I rotate the auth token my Phantom desktop client uses?
      - Can I issue a new Phantom client token if the old one leaked?
      instructions:
      - text: Regenerate the Phantom client auth token.
      - text: Rotate my Phantom desktop client token now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/launch'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch a Phantom profile on desktop
      effect: write
      questions:
      - How do I start a Phantom browser profile on my desktop client remotely?
      - Can I open a profile in the Phantom app from the API?
      instructions:
      - text: Launch Phantom profile {id} on my desktop client.
        slots:
          id: path.id
      - text: Start browser profile {id} in Phantom.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running Phantom profile
      effect: write
      questions:
      - Can I shut down a Phantom profile that is currently running?
      - What stops a running browser profile on the Phantom desktop client?
      instructions:
      - text: Stop running Phantom profile {id}.
        slots:
          id: path.id
      - text: Close the browser for profile {id} on the desktop client.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/navigate'].post
  update:
    x-apievangelist-phrasing:
      intent: Navigate a Phantom browser to a URL
      effect: write
      questions:
      - Can I tell a Phantom browser profile to open a specific web page?
      - How do I send the Phantom browser to a new URL?
      instructions:
      - text: Navigate Phantom profile {id} to the page I give you.
        slots:
          id: path.id
      - text: Open a new URL in browser profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/screenshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a Phantom browser screenshot
      effect: write
      questions:
      - Can I take a fresh screenshot of what a Phantom profile is showing?
      - Is a new screenshot returned as base64 JPEG data?
      instructions:
      - text: Take a new screenshot in Phantom profile {id}.
        slots:
          id: path.id
      - text: Capture the screen of browser profile {id} as base64 JPEG.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/screenshot.jpg'].get
  update:
    x-apievangelist-phrasing:
      intent: Download latest Phantom screenshot image
      effect: read
      questions:
      - Where can I get the most recent Phantom screenshot as a JPEG file?
      - Can I view the last captured screenshot image without taking a new one?
      instructions:
      - text: Download the latest screenshot JPEG for profile {id}.
        slots:
          id: path.id
      - text: Get the last captured image from Phantom profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/html'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current page HTML
      effect: read
      questions:
      - Can I read the HTML source of the page a Phantom profile has open?
      - What markup is the Phantom browser currently showing?
      instructions:
      - text: Get the HTML of the current page in profile {id}.
        slots:
          id: path.id
      - text: Dump the page source from Phantom profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/page-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current page URL and title
      effect: read
      questions:
      - Which page is a Phantom browser profile on right now?
      - Can I get just the URL and title of the open Phantom page?
      instructions:
      - text: Tell me the URL and title open in profile {id}.
        slots:
          id: path.id
      - text: Show the current page info for Phantom profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run JavaScript in the Phantom page
      effect: write
      questions:
      - Can I execute my own JavaScript inside the page a Phantom profile has open?
      - How do I run a script in the Phantom browser page context?
      instructions:
      - text: Execute a JavaScript snippet in Phantom profile {id}.
        slots:
          id: path.id
      - text: Run custom JS on the open page of profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/click'].post
  update:
    x-apievangelist-phrasing:
      intent: Click an element in the Phantom browser
      effect: write
      questions:
      - Can I click a button on the Phantom page using a CSS selector?
      - How do I make the Phantom browser click an element?
      instructions:
      - text: Click the element matching my CSS selector in profile {id}.
        slots:
          id: path.id
      - text: Press a button on the page open in Phantom profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/type'].post
  update:
    x-apievangelist-phrasing:
      intent: Type text into the Phantom browser
      effect: write
      questions:
      - Can I fill in a form field in the Phantom browser?
      - How do I type text into a selector or the focused input?
      instructions:
      - text: Type text into the input field in Phantom profile {id}.
        slots:
          id: path.id
      - text: Enter my text into the focused element of profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/cookies'].get
  update:
    x-apievangelist-phrasing:
      intent: Read cookies from the Phantom page
      effect: read
      questions:
      - What cookies does the current Phantom browser page have?
      - Can I export the cookies a Phantom profile is holding?
      instructions:
      - text: Get the cookies for the current page in profile {id}.
        slots:
          id: path.id
      - text: List cookies stored on Phantom profile {id}'s open site.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/cookies'].post
  update:
    x-apievangelist-phrasing:
      intent: Load cookies into the Phantom browser
      effect: write
      questions:
      - Can I import cookies so the Phantom worker browses a site already logged in?
      - Does setting cookies accept a Cookie-Editor or EditThisCookie export?
      instructions:
      - text: Set my exported cookies on Phantom profile {id}.
        slots:
          id: path.id
      - text: Log profile {id} into the site by loading these cookies.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/scroll'].post
  update:
    x-apievangelist-phrasing:
      intent: Scroll the Phantom browser page
      effect: write
      questions:
      - Can I scroll down the page open in a Phantom profile?
      - How do I make the Phantom browser scroll to load more content?
      instructions:
      - text: Scroll the current page in Phantom profile {id}.
        slots:
          id: path.id
      - text: Scroll down on browser profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/wait'].post
  update:
    x-apievangelist-phrasing:
      intent: Wait for a selector on the Phantom page
      effect: read
      questions:
      - Can I pause until an element shows up on the Phantom page?
      - How do I wait for a selector to appear before the next browser step?
      instructions:
      - text: Wait for my selector to appear in Phantom profile {id}.
        slots:
          id: path.id
      - text: Hold until the element loads on profile {id}'s page.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/solve-captcha'].post
  update:
    x-apievangelist-phrasing:
      intent: Solve a captcha on the Phantom page
      effect: write
      questions:
      - Can the Phantom browser solve a captcha blocking the current page?
      - Which service does Phantom use to solve captchas?
      instructions:
      - text: Solve the captcha on the page in Phantom profile {id}.
        slots:
          id: path.id
      - text: Get past the captcha blocking browser profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/proxy'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a proxy on a Phantom profile
      effect: write
      questions:
      - Can I route a Phantom browser profile through a proxy?
      - How do I configure proxy settings for one Phantom profile?
      instructions:
      - text: Set the proxy configuration on Phantom profile {id}.
        slots:
          id: path.id
      - text: Route browser profile {id} through my proxy.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/proxy'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a Phantom profile's proxy
      effect: destructive
      questions:
      - How do I stop a Phantom profile from using its proxy?
      - Can I clear the proxy settings from a browser profile?
      instructions:
      - text: Remove the proxy from Phantom profile {id}.
        slots:
          id: path.id
      - text: Clear proxy settings on browser profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/profiles/{id}/proxy/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a Phantom profile's proxy
      effect: write
      questions:
      - Is the proxy on my Phantom profile actually working?
      - What IP address does a Phantom profile show through its proxy?
      instructions:
      - text: Test the proxy on Phantom profile {id} and report the IP.
        slots:
          id: path.id
      - text: Check which IP browser profile {id} exits from.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/launches'].get
  update:
    x-apievangelist-phrasing:
      intent: List launches of a Phantom profile
      effect: read
      questions:
      - When was a Phantom profile last launched?
      - Can I see the launch history for one browser profile?
      instructions:
      - text: List the last {limit} launches of Phantom profile {profileId}.
        slots:
          limit: query.limit
          profileId: query.profileId
      - text: Show launch history for profile {profileId}.
        slots:
          profileId: query.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/scenarios'].get
  update:
    x-apievangelist-phrasing:
      intent: List Phantom browser scenarios
      effect: read
      questions:
      - Which automation scenarios have I built for the Phantom browser?
      - Can I see all saved Phantom scenarios?
      instructions:
      - text: List all my Phantom browser scenarios.
      - text: Show every saved Phantom automation scenario.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/scenarios'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Phantom browser scenario
      effect: write
      questions:
      - How do I save a new automation scenario for the Phantom browser?
      - Can I define a reusable Phantom scenario?
      instructions:
      - text: Create a new Phantom browser scenario.
      - text: Add an automation scenario for the Phantom browser.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/scenarios/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Phantom browser scenario
      effect: read
      questions:
      - What steps does a particular Phantom scenario contain?
      - Can I open a single Phantom scenario by id?
      instructions:
      - text: Show Phantom scenario {id}.
        slots:
          id: path.id
      - text: Fetch the definition of browser scenario {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/scenarios/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Phantom browser scenario
      effect: write
      questions:
      - Can I edit an existing Phantom automation scenario?
      - How do I change the steps of a saved Phantom scenario?
      instructions:
      - text: Update Phantom scenario {id} with my changes.
        slots:
          id: path.id
      - text: Edit browser scenario {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/scenarios/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Phantom browser scenario
      effect: destructive
      questions:
      - How do I remove a Phantom scenario I no longer need?
      - Can I delete one saved automation scenario?
      instructions:
      - text: Delete Phantom scenario {id}.
        slots:
          id: path.id
      - text: Remove browser scenario {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List Phantom browser schedules
      effect: read
      questions:
      - What Phantom browser runs are scheduled?
      - Can I see all Phantom schedules in my workspace?
      instructions:
      - text: List all my Phantom browser schedules.
      - text: Show the scheduled Phantom runs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Phantom browser schedule
      effect: write
      questions:
      - How do I schedule a Phantom browser run to happen automatically?
      - Can I set up a recurring Phantom schedule?
      instructions:
      - text: Create a new Phantom browser schedule.
      - text: Schedule an automatic Phantom browser run.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/schedules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Phantom browser schedule
      effect: write
      questions:
      - Can I change the timing of an existing Phantom schedule?
      - How do I edit a scheduled Phantom run?
      instructions:
      - text: Update Phantom schedule {id}.
        slots:
          id: path.id
      - text: Change the settings of browser schedule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/schedules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Phantom browser schedule
      effect: destructive
      questions:
      - How do I cancel a Phantom schedule permanently?
      - Can I remove a scheduled Phantom run?
      instructions:
      - text: Delete Phantom schedule {id}.
        slots:
          id: path.id
      - text: Remove browser schedule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/admin/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: View Phantom browser admin stats
      effect: read
      questions:
      - What usage stats are there for the Phantom browser across the platform?
      - Can a super admin see overall Phantom browser statistics?
      instructions:
      - text: Show the Phantom browser admin stats.
      - text: Get platform-wide Phantom usage statistics.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/phantom-browser/download/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the Phantom client config
      effect: read
      questions:
      - Where do I get the config.json for setting up the Phantom desktop client?
      - Can I download a Phantom config file with my token already in it?
      instructions:
      - text: Download my Phantom desktop client config.json.
      - text: Get the Phantom client config file with my token.
      method: generated
      generated: '2026-10-01'