Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Conversation API

2 actions 2 updates phrasing extends openapi/birdeye-conversation-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 2

$.info

$.paths['/v1/messenger/export'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Conversation API
  version: 1.0.0
extends: openapi/birdeye-conversation-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: 1
- target: $.paths['/v1/messenger/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export messenger conversations
      effect: read
      questions:
      - Can I export messenger conversations for a location over a date range?
      - Is there a way to exclude campaign messages from a conversation export?
      instructions:
      - text: Export conversations for business {businessNumber} using API key {apiKey}.
        slots:
          businessNumber: requestBody.businessNumber
          apiKey: requestBody.apiKey
      - text: List conversations for {businessNumber} from {startDate} to {endDate} without campaign messages, key {apiKey}.
        slots:
          businessNumber: requestBody.businessNumber
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          apiKey: requestBody.apiKey
      method: generated
      generated: '2026-09-26'