Stannp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stannp Direct Mail Account API

4 actions 4 updates phrasing extends openapi/stannp-account-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/accounts/balance'].get

$.paths['/accounts/topup'].post

$.paths['/users/me'].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 Stannp Direct Mail Account API
  version: 1.0.0
extends: openapi/stannp-account-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['/accounts/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the account balance
      effect: read
      questions:
      - How much credit is left on my Stannp account?
      - Do I have enough balance left to pay for my next mailing?
      instructions:
      - text: Show my current account balance.
      - text: Tell me how much money is left in my direct mail account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/topup'].post
  update:
    x-apievangelist-phrasing:
      intent: Add funds to the account balance
      effect: write
      questions:
      - Can I prepay credit onto my account so mailings draw from a balance?
      - Will tax be added on top of the amount I top up?
      instructions:
      - text: Top up my account balance by {net}.
        slots:
          net: requestBody.net
      - text: Add {net} of credit to my mailing account before tax.
        slots:
          net: requestBody.net
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up the signed-in user
      effect: read
      questions:
      - Which user is my API key authenticated as?
      - What profile details are on the account I'm logged in with?
      instructions:
      - text: Show the details of the user I'm authenticated as.
      - text: Confirm which user account this API key belongs to.
      method: generated
      generated: '2026-09-26'