beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Podcasts API

5 actions 5 updates phrasing extends openapi/beehiiv-podcasts-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 5

$.info

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

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

$.paths['/publications/{publicationId}/podcasts/{podcastShowId}/episodes'].get

$.paths['/publications/{publicationId}/podcasts/{podcastShowId}/episodes/{podcastEpisodeId}'].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 Podcasts API
  version: 1.0.0
extends: openapi/beehiiv-podcasts-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['/publications/{publicationId}/podcasts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publication's podcasts
      effect: read
      questions:
      - What podcast shows does my publication host?
      - Can I filter my podcasts by status?
      instructions:
      - text: List the podcasts on publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show {status} podcasts for {publication}.
        slots:
          status: query.status
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/podcasts/{podcastShowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one podcast show
      effect: read
      questions:
      - What are the details of a specific podcast show?
      - Can I pull a single podcast by its ID?
      instructions:
      - text: Get podcast show {podcast} on publication {publication}.
        slots:
          podcast: path.podcastShowId
          publication: path.publicationId
      - text: Show details for podcast {podcast}.
        slots:
          podcast: path.podcastShowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/podcasts/{podcastShowId}/episodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a podcast's episodes
      effect: read
      questions:
      - Which episodes have been published on my podcast?
      - Can I see only scheduled or draft episodes of a show?
      instructions:
      - text: List episodes of podcast {podcast} on publication {publication}.
        slots:
          podcast: path.podcastShowId
          publication: path.publicationId
      - text: Show {status} episodes for podcast {podcast}.
        slots:
          status: query.status
          podcast: path.podcastShowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/podcasts/{podcastShowId}/episodes/{podcastEpisodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one podcast episode
      effect: read
      questions:
      - What are the details of one particular podcast episode?
      - Can I look up a single episode by its ID?
      instructions:
      - text: Get episode {episode} of podcast {podcast} on publication {publication}.
        slots:
          episode: path.podcastEpisodeId
          podcast: path.podcastShowId
          publication: path.publicationId
      - text: Show podcast episode {episode}.
        slots:
          episode: path.podcastEpisodeId
      method: generated
      generated: '2026-09-26'