# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Search AI API
  version: 1.0.0
extends: openapi/birdeye-search-ai-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: 8
- target: $.paths['/v1/listing/searchAi/account-setup'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my account's Search AI setup
      effect: read
      questions:
      - What is the Search AI setup on the account I'm signed into?
      - Can I view my own Search AI configuration without naming a business number?
      instructions:
      - text: Get my Search AI account setup.
      - text: Show the Search AI configuration for the account tied to my login.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/searchAi/available-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my account's remaining Search AI runs
      effect: read
      questions:
      - How many Search AI runs do I have left on my account?
      - Can I check remaining Search AI runs for the account I'm signed into?
      instructions:
      - text: Get my available Search AI runs.
      - text: Show the Search AI runs remaining on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/searchAi/public/citations'].post
  update:
    x-apievangelist-phrasing:
      intent: Get sources AI models cite for my business
      effect: read
      questions:
      - Which sources do AI models cite when answering about my business?
      - Can I filter Search AI citations by AI model or theme?
      instructions:
      - text: Get Search AI citations for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: Show {aiModel} citations for theme {theme} from {startDate} to {endDate}.
        slots:
          aiModel: requestBody.aiModel
          theme: requestBody.theme
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/searchAi/public/business'].post
  update:
    x-apievangelist-phrasing:
      intent: Get businesses surfaced in AI search
      effect: read
      questions:
      - Which businesses appear in AI search answers for my themes?
      - Can I see the businesses surfaced by a given AI model?
      instructions:
      - text: Get Search AI businesses for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: List businesses surfaced by {aiModel} for theme {theme}.
        slots:
          aiModel: requestBody.aiModel
          theme: requestBody.theme
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/searchAi/public/aio-details?page-size=100&start-index=0'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the AI answer accuracy report
      effect: read
      questions:
      - How accurate is the information AI models give about my locations?
      - Can I get an accuracy report per AI model?
      instructions:
      - text: Get the Search AI accuracy report for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: Check AI answer accuracy for models {aiModels} from {startDate} to {endDate}.
        slots:
          aiModels: requestBody.aiModels
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/searchAi/public/swot-details?page-size=100&start-index=0'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the AI search sentiment report
      effect: read
      questions:
      - What sentiment do AI models express about my business?
      - Can I see the strengths and weaknesses AI search attributes to my locations?
      instructions:
      - text: Get the Search AI sentiment report for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: Show AI sentiment for models {aiModels} from {startDate} to {endDate}.
        slots:
          aiModels: requestBody.aiModels
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/searchAi/public/account-setup'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business's Search AI setup as a partner
      effect: read
      questions:
      - Can a partner fetch the Search AI configuration for a specific business number?
      - Which partner endpoint returns the Search AI setup for one business?
      instructions:
      - text: Get the Search AI configuration for business {businessNumber} using partner key {apiKey}.
        slots:
          businessNumber: header.x-business-number
          apiKey: header.x-api-key
      - text: Fetch Search AI setup via the public partner endpoint for {businessNumber}.
        slots:
          businessNumber: header.x-business-number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/searchAi/public/available-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business's Search AI runs as a partner
      effect: read
      questions:
      - Can a partner check available Search AI runs for a given business number?
      - Is there a public partner endpoint for Search AI run availability per business?
      instructions:
      - text: Get available Search AI runs for business {businessNumber} with partner key {apiKey}.
        slots:
          businessNumber: header.x-business-number
          apiKey: header.x-api-key
      - text: Check Search AI run availability via the public partner endpoint for {businessNumber}.
        slots:
          businessNumber: header.x-business-number
      method: generated
      generated: '2026-09-26'