beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Polls API

4 actions 4 updates phrasing extends openapi/beehiiv-polls-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for beehiiv's API. It is a proposal applied on top of the contract, not a document beehiiv publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/publications/{publicationId}/polls'].get

$.paths['/publications/{publicationId}/polls/{pollId}'].get

$.paths['/publications/{publicationId}/polls/{pollId}/responses'].get

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 Reference Polls API
  version: 1.0.0
extends: openapi/beehiiv-polls-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: 3
- target: $.paths['/publications/{publicationId}/polls'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publication's polls
      effect: read
      questions:
      - What polls have I run in my newsletter?
      - Can I list only the polls that appeared in a specific post?
      instructions:
      - text: List polls on publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show polls used in post {post} on {publication}.
        slots:
          post: query.post_id
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/polls/{pollId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one poll and its vote counts
      effect: read
      questions:
      - How many votes did each choice get on a specific poll?
      - Can I see the choices and totals for a single poll?
      instructions:
      - text: Get poll {poll} on publication {publication}.
        slots:
          poll: path.pollId
          publication: path.publicationId
      - text: Show the vote stats for poll {poll}.
        slots:
          poll: path.pollId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/polls/{pollId}/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List individual responses to a poll
      effect: read
      questions:
      - Which subscribers answered a poll, and what did each one pick?
      - How do I export every individual response for a large poll?
      instructions:
      - text: List every subscriber response to poll {poll} on publication {publication}.
        slots:
          poll: path.pollId
          publication: path.publicationId
      - text: Page through responses to poll {poll} from cursor {cursor}.
        slots:
          poll: path.pollId
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'