# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Social API
  version: 1.0.0
extends: openapi/birdeye-social-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/social/{accountNumber}/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a social media post
      effect: write
      questions:
      - Can I schedule a social media post for a future time?
      - Can one scheduled post go out to several locations with media?
      instructions:
      - text: Schedule post {text} on {socialSite} for account {accountNumber} at {scheduleTimestamp}.
        slots:
          text: requestBody.text
          socialSite: requestBody.socialSite
          accountNumber: path.accountNumber
          scheduleTimestamp: requestBody.scheduleTimestamp
      - text: Schedule a {socialSite} post saying {text} for locations {subBusinessNumbers} under {accountNumber}.
        slots:
          socialSite: requestBody.socialSite
          text: requestBody.text
          subBusinessNumbers: requestBody.subBusinessNumbers
          accountNumber: path.accountNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/social/post/public/scheduled/edit/{accountNumber}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a scheduled social post
      effect: write
      questions:
      - Can I change a post that's scheduled but not yet published?
      - Is it possible to move a scheduled post to a different time?
      instructions:
      - text: Edit scheduled post {trackingId} on account {accountNumber} to say {text}.
        slots:
          trackingId: requestBody.trackingId
          accountNumber: path.accountNumber
          text: requestBody.text
      - text: Reschedule post {trackingId} for {accountNumber} to {scheduleTimestamp}.
        slots:
          trackingId: requestBody.trackingId
          accountNumber: path.accountNumber
          scheduleTimestamp: requestBody.scheduleTimestamp
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/social/post/public/published/edit/{accountNumber}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a published social post
      effect: write
      questions:
      - Can I edit a social post after it has already been published?
      - Is there a way to fix a typo in a live post?
      instructions:
      - text: Edit published post {trackingId} on account {accountNumber} to read {text}.
        slots:
          trackingId: requestBody.trackingId
          accountNumber: path.accountNumber
          text: requestBody.text
      - text: Update the live {socialSite} post {trackingId} for {accountNumber}.
        slots:
          socialSite: requestBody.socialSite
          trackingId: requestBody.trackingId
          accountNumber: path.accountNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/social/post/public/delete/{accountNumber}'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a social post
      effect: destructive
      questions:
      - Can I delete a social post from specific locations?
      - Is there a way to take down a post that went out?
      instructions:
      - text: Delete social post {trackingId} from locations {subBusinessNumbers} on account {accountNumber}.
        slots:
          trackingId: requestBody.trackingId
          subBusinessNumbers: requestBody.subBusinessNumbers
          accountNumber: path.accountNumber
      - text: Take down post {trackingId} for account {accountNumber}.
        slots:
          trackingId: requestBody.trackingId
          accountNumber: path.accountNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/social/{accountNumber}/post/track/{trackingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Track a social post's status
      effect: read
      questions:
      - Did my social post publish successfully?
      - Can I check a post's status with its tracking ID?
      instructions:
      - text: Track post {trackingId} on account {accountNumber}.
        slots:
          trackingId: path.trackingId
          accountNumber: path.accountNumber
      - text: Check the publish status of post {trackingId} for {accountNumber}.
        slots:
          trackingId: path.trackingId
          accountNumber: path.accountNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/social/open-url/performance/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the social open URL performance report
      effect: read
      questions:
      - Can I get the social open URL performance report for a date range?
      - Can I compare open URL performance with a previous period by channel?
      instructions:
      - text: Get the social open URL performance report from {startDate} to {endDate}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Show open URL performance for {sourceNames} between {startDate} and {endDate}.
        slots:
          sourceNames: requestBody.sourceNames
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/social/post/public/media/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload images or videos to the media library
      effect: write
      questions:
      - Can I upload images or videos from URLs into the social media library?
      - How many media URLs can I upload in one batch, and which formats work?
      instructions:
      - text: Upload media {media_urls} to the social library for business {businessNumber} with key {apiKey}.
        slots:
          media_urls: requestBody.media_urls
          businessNumber: header.x-business-number
          apiKey: header.x-api-key
      - text: Queue image URLs {media_urls} into folder {folder_id} for business {businessNumber}.
        slots:
          media_urls: requestBody.media_urls
          folder_id: requestBody.folder_id
          businessNumber: header.x-business-number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/social/post/public/media/track/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a media upload batch's status
      effect: read
      questions:
      - Has my media upload batch finished processing?
      - Where do I get asset IDs for uploaded media to attach to a post?
      instructions:
      - text: Track media upload batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Check the status of upload batch {batch_id} for business {businessNumber}.
        slots:
          batch_id: path.batch_id
          businessNumber: header.x-business-number
      method: generated
      generated: '2026-09-26'