beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OAuth2 Tokens API

5 actions 5 updates phrasing extends openapi/beehiiv-tokens-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['/oauth/token'].post

$.paths['/oauth/revoke'].post

$.paths['/oauth/introspect'].post

$.paths['/oauth/token/info'].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 OAuth2 Tokens API
  version: 1.0.0
extends: openapi/beehiiv-tokens-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['/oauth/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a code or refresh token for access
      effect: write
      questions:
      - How do I turn an OAuth authorization code into an access token?
      - Can I refresh an expired access token with my refresh token?
      instructions:
      - text: Exchange authorization code {code} for an access token using grant type {grant_type}.
        slots:
          code: requestBody.code
          grant_type: requestBody.grant_type
      - text: Get a new access token from refresh token {refresh_token} with grant type {grant_type}.
        slots:
          refresh_token: requestBody.refresh_token
          grant_type: requestBody.grant_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an access or refresh token
      effect: destructive
      questions:
      - How do I revoke a token when a user disconnects my app?
      - Can I invalidate a refresh token instead of an access token?
      instructions:
      - text: Revoke token {token}.
        slots:
          token: requestBody.token
      - text: Revoke {token} as a {token_type_hint}.
        slots:
          token: requestBody.token
          token_type_hint: requestBody.token_type_hint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth/introspect'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a token is active
      effect: read
      questions:
      - Is a given OAuth token still valid?
      - What metadata can I learn about an arbitrary token I hold?
      instructions:
      - text: Introspect token {token} and tell me if it is active.
        slots:
          token: requestBody.token
      - text: Check whether {token} is still a valid {token_type_hint}.
        slots:
          token: requestBody.token
          token_type_hint: requestBody.token_type_hint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth/token/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get info about the current access token
      effect: read
      questions:
      - What scopes and expiry does the access token I'm calling with have?
      - When does my current bearer token expire?
      instructions:
      - text: Show metadata for the access token I'm using right now.
      - text: Tell me the scopes and expiry of my current bearer token.
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/beehiiv-tokens-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.