Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Billing Meter API

7 actions 7 updates phrasing extends openapi/thehiveryiq-com-billing-meter-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/billing/meter/health'].get
$.paths['/v1/billing/activate'].post
$.paths['/v1/billing/usage/{account_id}'].get
$.paths['/v1/billing/topup/intent'].post
$.paths['/v1/billing/topup/{intent_id}'].get
$.paths['/v1/billing/whoami'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Billing Meter API
  version: 1.0.0
extends: openapi/thehiveryiq-com-billing-meter-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: 6
- target: $.paths['/v1/billing/meter/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the billing meter and its prices
      effect: read
      questions:
      - What does the usage meter charge, and which chains can I pay on?
      - Where can I see the billing meter schema?
      instructions:
      - text: Show me the billing meter schema and prices.
      - text: List the chains the meter accepts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a metered billing account
      effect: write
      questions:
      - How do I bind my activation key to a metered account?
      - Can I attach a wallet when activating billing, and is it safe to repeat?
      instructions:
      - text: Activate metering for key {activation_key_id}.
        slots:
          activation_key_id: requestBody.activation_key_id
      - text: Activate key {activation_key_id} with wallet {wallet_addr} labeled {label}.
        slots:
          activation_key_id: requestBody.activation_key_id
          wallet_addr: requestBody.wallet_addr
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/usage/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account's signed usage snapshot
      effect: read
      questions:
      - How much has my metered account used so far?
      - Is the usage snapshot signed so I can verify it?
      instructions:
      - text: Show usage for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Get the signed usage snapshot for {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/topup/intent'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a USDC top-up
      effect: write
      questions:
      - How do I add USDC credit to my metered account?
      - What treasury address and memo do I use to top up?
      instructions:
      - text: Top up account {account_id} with {amount_cents} cents of USDC on {chain}.
        slots:
          account_id: requestBody.account_id
          amount_cents: requestBody.amount_cents
          chain: requestBody.chain
      - text: Create a top-up intent for {account_id} on {chain} worth {amount_cents} cents.
        slots:
          account_id: requestBody.account_id
          chain: requestBody.chain
          amount_cents: requestBody.amount_cents
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/topup/{intent_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a top-up's settlement status
      effect: read
      questions:
      - Has my USDC top-up settled yet?
      - Can I track a top-up intent after I send funds?
      instructions:
      - text: Check top-up {intent_id}.
        slots:
          intent_id: path.intent_id
      - text: Tell me whether top-up intent {intent_id} has settled.
        slots:
          intent_id: path.intent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/whoami'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the account for my activation key
      effect: read
      questions:
      - Which billing account does my activation key belong to?
      - Can I resolve my key to an account ID for the billing dashboard?
      instructions:
      - text: Tell me which billing account I'm using.
      - text: Resolve my activation key to its account ID.
      method: generated
      generated: '2026-09-26'