Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Business Media API

5 actions 5 updates phrasing extends openapi/birdeye-business-media-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Birdeye's API. It is a proposal applied on top of the contract, not a document Birdeye publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/business/{businessNumber}/upload/media'].post
$.paths['/v1/business/{businessNumber}/media/get'].get
$.paths['/v1/business/{businessNumber}/update/media/{mediaId}'].put
$.paths['/v1/business/{businessNumber}/media/delete'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Business Media API
  version: 1.0.0
extends: openapi/birdeye-business-media-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: 4
- target: $.paths['/v1/business/{businessNumber}/upload/media'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload media to a location
      effect: write
      questions:
      - Can I upload photos to a location's business profile media?
      - What's needed to add media to a single location?
      instructions:
      - text: Add media {media} to location {businessNumber}.
        slots:
          media: requestBody.media
          businessNumber: path.businessNumber
      - text: 'Upload these photos to business {businessNumber}: {media}.'
        slots:
          media: requestBody.media
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/{businessNumber}/media/get'].get
  update:
    x-apievangelist-phrasing:
      intent: List a location's media
      effect: read
      questions:
      - Which photos and media are currently attached to my location?
      - Can I list a business's media library?
      instructions:
      - text: Get the media for location {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      - text: List all photos on business {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/{businessNumber}/update/media/{mediaId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a media item's category
      effect: write
      questions:
      - Can I recategorize a media item already uploaded to a location?
      - Is it possible to change which category an existing photo belongs to?
      instructions:
      - text: Set media {mediaId} on location {businessNumber} to category {mediaCategory}.
        slots:
          mediaId: path.mediaId
          businessNumber: path.businessNumber
          mediaCategory: requestBody.mediaCategory
      - text: Recategorize media item {mediaId} for business {businessNumber}.
        slots:
          mediaId: path.mediaId
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/business/{businessNumber}/media/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete media from a location
      effect: destructive
      questions:
      - Can I delete media from a location's profile?
      - Is there a way to clear photos off a business listing?
      instructions:
      - text: Delete media from location {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      - text: Remove photos from business {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'