IBANforge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for IBANforge Credits API

4 actions 4 updates phrasing extends openapi/ibanforge-credits-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/credits/balance'].get

$.paths['/v1/credits/bundles'].get

$.paths['/v1/credits/buy/{bundle}'].post

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 IBANforge Credits API
  version: 1.0.0
extends: openapi/ibanforge-credits-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['/v1/credits/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the prepaid credit balance of a key
      effect: read
      questions:
      - How many prepaid credits are left on my key?
      - Does my key use its allowance before its credits?
      instructions:
      - text: Show the remaining credits on my API key.
      - text: Get my credit balance and the top-up links for this key.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credits/bundles'].get
  update:
    x-apievangelist-phrasing:
      intent: List prepaid credit bundles and prices
      effect: read
      questions:
      - What prepaid credit bundles are available and what do they cost?
      - Do purchased credits ever expire?
      instructions:
      - text: List the prepaid credit bundles with prices.
      - text: Show the credit packs and the monthly subscription option.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credits/buy/{bundle}'].post
  update:
    x-apievangelist-phrasing:
      intent: Buy a prepaid credit bundle with USDC
      effect: write
      questions:
      - Can I pay with USDC on Base to add credits to the key I already have?
      - What happens if I buy a bundle without presenting an API key?
      instructions:
      - text: Buy the {bundle} credit bundle for my current key.
        slots:
          bundle: path.bundle
      - text: Purchase bundle {bundle} and attach the new key to {email}.
        slots:
          bundle: path.bundle
          email: requestBody.email
      method: generated
      generated: '2026-09-26'