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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Reference Ad Network Offers API
version: 1.0.0
extends: openapi/beehiiv-ad-network-offers-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}/ad_network/offers'].get
update:
x-apievangelist-phrasing:
intent: List ad network offers for a publication
effect: read
questions:
- What ad offers are available for my newsletter to run right now?
- Can I see which sponsorship offers the beehiiv ad network has for my publication?
- Which advertisers are offering to place ads in my newsletter?
instructions:
- text: Show me the ad offers available for publication {publication}.
slots:
publication: path.publicationId
- text: List ad network offers for {publication} requested from {requested_from}.
slots:
publication: path.publicationId
requested_from: query.requested_from
method: generated
generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/ad_network/offers'].post
update:
x-apievangelist-phrasing:
intent: Accept an ad offer and place it in a post
effect: write
questions:
- How do I accept an ad network offer and drop the ad into one of my posts?
- Can I take a sponsorship offer and attach its creative to a specific post in one step?
instructions:
- text: Accept ad offer {offer} with creative {advertisement} and insert it into post {post} on {publication}.
slots:
offer: requestBody.offer_id
advertisement: requestBody.advertisement_id
post: requestBody.post_id
publication: path.publicationId
- text: Take ad network offer {offer} using creative {advertisement} and run it in post {post}.
slots:
offer: requestBody.offer_id
advertisement: requestBody.advertisement_id
post: requestBody.post_id
method: generated
generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/ad_network/offers/{offerId}/advertisements'].get
update:
x-apievangelist-phrasing:
intent: List the ad creatives for an ad offer
effect: read
questions:
- What ad copy comes with a particular ad network offer?
- Which text ad creatives can I choose from before accepting an offer?
instructions:
- text: Show the active ad creatives for offer {offer} on publication {publication}.
slots:
offer: path.offerId
publication: path.publicationId
- text: List the text advertisements I can pick from for ad offer {offer} in {publication}.
slots:
offer: path.offerId
publication: path.publicationId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.