Birdeye · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Birdeye Google Q&A API
10 actions
10 updates
phrasing
extends
openapi/birdeye-google-q-a-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.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/v1/qna/question/create'].post
$.paths['/v1/qna/answer/create'].post
$.paths['/v1/qna/question/update'].put
$.paths['/v1/qna/answer/update'].put
$.paths['/v1/qna/question/delete'].post
$.paths['/v1/qna/answer/delete'].post
$.paths['/v1/qna/question/deleteAll'].delete
$.paths['/v1/qna/get'].post
$.paths['/v1/qna/unanswered/get'].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 Google Q&A API
version: 1.0.0
extends: openapi/birdeye-google-q-a-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: 9
- target: $.paths['/v1/qna/question/create'].post
update:
x-apievangelist-phrasing:
intent: Post a question and answer
effect: write
questions:
- Can I post a question and its answer to my Google profile Q&A?
- What's needed to seed a new Q&A pair for a location?
instructions:
- text: Create question {question} with answer {answer} for business {businessId}.
slots:
question: requestBody.question
answer: requestBody.answer
businessId: query.businessId
- text: 'Seed a new Q&A pair on {businessId}: {question} answered {answer}.'
slots:
businessId: query.businessId
question: requestBody.question
answer: requestBody.answer
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/answer/create'].post
update:
x-apievangelist-phrasing:
intent: Answer an existing question
effect: write
questions:
- Can I answer a question someone already asked on my Google profile?
- Can I add an answer to an existing Q&A question?
instructions:
- text: Answer question {questionId} with {answer} for business {businessId}.
slots:
questionId: requestBody.questionId
answer: requestBody.answer
businessId: query.businessId
- text: Reply to Google question {questionId} on {businessId} with {answer}.
slots:
questionId: requestBody.questionId
businessId: query.businessId
answer: requestBody.answer
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/question/update'].put
update:
x-apievangelist-phrasing:
intent: Edit a posted question
effect: write
questions:
- Can I edit the wording of a question I posted?
- Is it possible to reword a Q&A question after it's live?
instructions:
- text: Change question {questionId} on {businessId} to {question}.
slots:
questionId: requestBody.questionId
businessId: query.businessId
question: requestBody.question
- text: Reword Q&A question {questionId} to {question} for business {businessId}.
slots:
questionId: requestBody.questionId
question: requestBody.question
businessId: query.businessId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/answer/update'].put
update:
x-apievangelist-phrasing:
intent: Edit a posted answer
effect: write
questions:
- Can I edit an answer already posted to a question?
- Is it possible to correct a Q&A answer after publishing?
instructions:
- text: Update answer {answerId} on question {questionId} to {answer} for {businessId}.
slots:
answerId: requestBody.answerId
questionId: requestBody.questionId
answer: requestBody.answer
businessId: query.businessId
- text: Correct answer {answerId} of question {questionId} to read {answer} on business {businessId}.
slots:
answerId: requestBody.answerId
questionId: requestBody.questionId
answer: requestBody.answer
businessId: query.businessId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/question/delete'].post
update:
x-apievangelist-phrasing:
intent: Delete a question
effect: destructive
questions:
- Can I delete a single question from my Google Q&A?
- Is there a way to take down one question I posted?
instructions:
- text: Delete question {questionId} from business {businessId}.
slots:
questionId: requestBody.questionId
businessId: query.businessId
- text: Remove Q&A question {questionId} on {businessId}.
slots:
questionId: requestBody.questionId
businessId: query.businessId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/answer/delete'].post
update:
x-apievangelist-phrasing:
intent: Delete an answer
effect: destructive
questions:
- Can I delete one answer but keep the question?
- Is it possible to remove an answer I posted on a location's Q&A?
instructions:
- text: Delete answer {answerId} from question {questionId} on {businessId}.
slots:
answerId: requestBody.answerId
questionId: requestBody.questionId
businessId: query.businessId
- text: Remove answer {answerId} under question {questionId} for business {businessId}.
slots:
answerId: requestBody.answerId
questionId: requestBody.questionId
businessId: query.businessId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/question/deleteAll'].delete
update:
x-apievangelist-phrasing:
intent: Delete all Q&A for a business
effect: destructive
questions:
- Can I wipe every question and answer from a location at once?
- Is there a bulk delete for all Google Q&A on a business?
instructions:
- text: Delete all questions and answers for business {businessId}.
slots:
businessId: query.businessId
- text: Clear the entire Q&A of {businessId}.
slots:
businessId: query.businessId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/get'].post
update:
x-apievangelist-phrasing:
intent: List all questions and answers
effect: read
questions:
- Can I list all Q&A on my Google profile?
- Can I page through every question and answer for a business?
instructions:
- text: Get questions and answers for {businessId} from index {startIndex}, page size {pageSize}.
slots:
businessId: query.businessId
startIndex: requestBody.startIndex
pageSize: requestBody.pageSize
- text: List all Q&A on business {businessId}, {pageSize} at a time starting at {startIndex}.
slots:
businessId: query.businessId
pageSize: requestBody.pageSize
startIndex: requestBody.startIndex
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/qna/unanswered/get'].post
update:
x-apievangelist-phrasing:
intent: List unanswered questions
effect: read
questions:
- Which questions on my Google profile still have no answer?
- Can I list only unanswered questions for a location?
instructions:
- text: List unanswered questions for {businessId} from {startIndex}, page size {pageSize}.
slots:
businessId: query.businessId
startIndex: requestBody.startIndex
pageSize: requestBody.pageSize
- text: Find questions awaiting an answer on {businessId}, starting {startIndex}, {pageSize} per page.
slots:
businessId: query.businessId
startIndex: requestBody.startIndex
pageSize: requestBody.pageSize
method: generated
generated: '2026-09-26'