# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Reviews API
  version: 1.0.0
extends: openapi/birdeye-reviews-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['/v1/review/businessId/{businessId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get reviews for a business
      effect: read
      questions:
      - Can I pull reviews for a business filtered by date, rating and source?
      - Can I include reviews from sources that aren't auto-crawled?
      instructions:
      - text: Get {count} reviews for business {businessId} starting at {sindex}.
        slots:
          count: query.count
          businessId: path.businessId
          sindex: query.sindex
      - text: Fetch {ratings}-star reviews for {businessId} from {fromDate} to {toDate}, start {sindex}, count {count}.
        slots:
          ratings: requestBody.ratings
          businessId: path.businessId
          fromDate: requestBody.fromDate
          toDate: requestBody.toDate
          sindex: query.sindex
          count: query.count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/archive/public'].post
  update:
    x-apievangelist-phrasing:
      intent: Get archived reviews
      effect: read
      questions:
      - Can I retrieve reviews that were archived or deleted?
      - Can I filter archived reviews by when they were deleted?
      instructions:
      - text: Get archived reviews for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: List archived reviews deleted between {deleteStartDate} and {deleteEndDate}.
        slots:
          deleteStartDate: requestBody.deleteStartDate
          deleteEndDate: requestBody.deleteEndDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/businessid/{businessId}/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business's review summary
      effect: read
      questions:
      - What does my overall review summary look like for a business?
      - Can I summarize only featured reviews?
      instructions:
      - text: Get the review summary for {businessId}.
        slots:
          businessId: path.businessId
      - text: Summarize {statuses} reviews for business {businessId}.
        slots:
          statuses: query.statuses
          businessId: path.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/reply/business/{businessNumber}/review/{reviewId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Reply to a review
      effect: write
      questions:
      - Can I reply to a customer review through the API?
      - Can I send a private response to a reviewer?
      instructions:
      - text: Reply to review {reviewId} on {businessNumber} with {response}.
        slots:
          reviewId: path.reviewId
          businessNumber: path.businessNumber
          response: requestBody.response
      - text: 'Send a private reply to review {reviewId} for business {businessNumber}: {response}.'
        slots:
          reviewId: path.reviewId
          businessNumber: path.businessNumber
          response: requestBody.response
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tag'].post
  update:
    x-apievangelist-phrasing:
      intent: Create review tags
      effect: write
      questions:
      - Can I create review tags for a business?
      - Is it possible to define several new tags in one call?
      instructions:
      - text: Create tags {tags} for business {businessId}.
        slots:
          tags: requestBody.tags
          businessId: query.businessId
      - text: Add new review tags {tags} to {businessId}.
        slots:
          tags: requestBody.tags
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tag/{tagname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a review tag
      effect: destructive
      questions:
      - Can I delete a review tag I no longer need?
      - Is there a way to remove one tag definition by name?
      instructions:
      - text: Delete tag {tagname} from business {businessId}.
        slots:
          tagname: path.tagname
          businessId: query.businessId
      - text: Remove the {tagname} tag definition for {businessId}.
        slots:
          tagname: path.tagname
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tag/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List review tags
      effect: read
      questions:
      - Which review tags exist for my business?
      - Can I see every tag defined on a location?
      instructions:
      - text: List all tags for {businessId}.
        slots:
          businessId: query.businessId
      - text: Show every review tag defined on {businessId}.
        slots:
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tag/add/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a filtered set of reviews
      effect: write
      questions:
      - Can I tag a filtered set of reviews in bulk?
      - Is it possible to apply several tags to matching reviews at once?
      instructions:
      - text: Assign tags {tag} to filtered reviews of business {bid}.
        slots:
          tag: query.tag
          bid: query.bid
      - text: Bulk-tag the filtered reviews of {bid} with {tag}.
        slots:
          bid: query.bid
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tag/remove/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Untag a filtered set of reviews
      effect: write
      questions:
      - Can I strip certain tags from a filtered set of reviews?
      - Is there a way to untag only the reviews matching a filter?
      instructions:
      - text: Remove tags {tag} from the filtered reviews of {bid}.
        slots:
          tag: query.tag
          bid: query.bid
      - text: Untag filtered reviews of business {bid} for {tag}.
        slots:
          bid: query.bid
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/tag/remove/all/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from every review
      effect: write
      questions:
      - Can I remove a tag from every review at once?
      - Is there a way to clear specific tags off all of a business's reviews?
      instructions:
      - text: Remove tags {tags} from all reviews of {bid}.
        slots:
          tags: requestBody.tags
          bid: query.bid
      - text: Strip {tags} off every review for business {bid}.
        slots:
          tags: requestBody.tags
          bid: query.bid
      method: generated
      generated: '2026-09-26'