# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Xquik Monitors API
  version: 1.0.0
extends: openapi/xquik-api-monitors-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: 10
- target: $.paths['/api/v1/monitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List my account monitors
      effect: read
      questions:
      - Which X accounts am I currently monitoring?
      - Can I see all my account monitors?
      instructions:
      - text: List my account monitors.
      - text: Show every X account I'm watching.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Monitor an X account for activity
      effect: write
      questions:
      - How do I get alerted when a specific X account posts?
      - How much does an active account monitor cost per hour?
      instructions:
      - text: Monitor @{username} for {eventTypes}.
        slots:
          username: requestBody.username
          eventTypes: requestBody.eventTypes
      - text: 'Start watching {username} for these event types: {eventTypes}.'
        slots:
          username: requestBody.username
          eventTypes: requestBody.eventTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/keywords'].get
  update:
    x-apievangelist-phrasing:
      intent: List my keyword monitors
      effect: read
      questions:
      - Which keyword monitors do I have running?
      - Can I list all the keyword searches being tracked for me?
      instructions:
      - text: List my keyword monitors.
      - text: Show all keyword monitors on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/keywords'].post
  update:
    x-apievangelist-phrasing:
      intent: Monitor X for a keyword
      effect: write
      questions:
      - Can I get notified whenever a keyword is tweeted?
      - How often does a keyword monitor check for new matches?
      instructions:
      - text: Create a keyword monitor for {query} tracking {eventTypes}.
        slots:
          query: requestBody.query
          eventTypes: requestBody.eventTypes
      - text: Watch X for the phrase {query} and capture {eventTypes} events.
        slots:
          query: requestBody.query
          eventTypes: requestBody.eventTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/keywords/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a keyword monitor
      effect: read
      questions:
      - Can I look up the settings of one keyword monitor?
      - Is a particular keyword monitor still active?
      instructions:
      - text: Get keyword monitor {id}.
        slots:
          id: path.id
      - text: Show the details of keyword monitor {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/keywords/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a keyword monitor
      effect: destructive
      questions:
      - What's the way to delete a keyword monitor I no longer need?
      - Can I remove a keyword monitor so it stops running?
      instructions:
      - text: Delete keyword monitor {id}.
        slots:
          id: path.id
      - text: Remove keyword monitor {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/keywords/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause or change a keyword monitor
      effect: write
      questions:
      - Can I pause a keyword monitor without deleting it?
      - Can I change which event types a keyword monitor tracks?
      instructions:
      - text: Set keyword monitor {id} to track {eventTypes}.
        slots:
          id: path.id
          eventTypes: requestBody.eventTypes
      - text: Set keyword monitor {id} active status to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account monitor
      effect: read
      questions:
      - Can I check the settings of one account monitor?
      - Is my monitor on a given X account still running?
      instructions:
      - text: Get account monitor {id}.
        slots:
          id: path.id
      - text: Show details of the account monitor {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account monitor
      effect: destructive
      questions:
      - How do I stop monitoring an X account permanently?
      - Can I delete an account monitor?
      instructions:
      - text: Delete account monitor {id}.
        slots:
          id: path.id
      - text: Stop and remove the account monitor {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/monitors/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause or change an account monitor
      effect: write
      questions:
      - Can I temporarily pause an account monitor?
      - Can I change the event types an account monitor watches?
      instructions:
      - text: Change account monitor {id} to watch {eventTypes}.
        slots:
          id: path.id
          eventTypes: requestBody.eventTypes
      - text: Set account monitor {id} active to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      method: generated
      generated: '2026-09-26'