# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BrowserStack Automate REST Sessions API
  version: 1.0.0
extends: openapi/browserstack-sessions-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: 7
- target: $.paths['/automate/builds/{buildId}/sessions.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the test sessions in a build
      effect: read
      questions:
      - How do I see all the test sessions that ran in one build?
      - Which sessions in a build passed and which failed?
      instructions:
      - text: List the sessions in build {buildId}.
        slots:
          buildId: path.buildId
      - text: Show every test session that ran under build {buildId}.
        slots:
          buildId: path.buildId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/sessions/{sessionId}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one test session
      effect: read
      questions:
      - How do I look up a single Automate session's details and status?
      - What browser, OS and result did a specific test session run with?
      instructions:
      - text: Get the details of session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Show me the status and browser of test session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/sessions/{sessionId}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a session passed or failed
      effect: write
      questions:
      - How do I mark a BrowserStack session as passed or failed from my test script?
      - Can I record a reason when I flag a test session as failed?
      - Is it possible to rename a session after it finishes?
      instructions:
      - text: Mark session {sessionId} as {status} with reason {reason}.
        slots:
          sessionId: path.sessionId
          status: requestBody.status
          reason: requestBody.reason
      - text: Rename session {sessionId} to {name}.
        slots:
          sessionId: path.sessionId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/sessions/{sessionId}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test session
      effect: destructive
      questions:
      - How do I delete a single test session and its recordings?
      - Can I remove one session without deleting the whole build?
      instructions:
      - text: Delete session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Permanently remove test session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/sessions/{sessionId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a session's Selenium logs
      effect: read
      questions:
      - Where can I get the Selenium command logs for a test run?
      - How do I download the raw Selenium log to debug a failing session?
      instructions:
      - text: Download the Selenium logs for session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Fetch the Selenium command log of session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/sessions/{sessionId}/networklogs'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a session's network logs (HAR)
      effect: read
      questions:
      - How do I get the HAR file of network traffic from a test session?
      - Can I see which network requests failed during an automated test?
      instructions:
      - text: Download the network HAR log for session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Get the captured network traffic of session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automate/sessions/{sessionId}/consolelogs'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a session's browser console logs
      effect: read
      questions:
      - What JavaScript errors showed up in the browser console during my test?
      - How do I download the console logs from an Automate session?
      instructions:
      - text: Download the browser console logs for session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: Show the JavaScript console output from session {sessionId}.
        slots:
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'