Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Mos Energy Arb API

4 actions 4 updates phrasing extends openapi/thehiveryiq-com-mos-energy-arb-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 4

$.info
$.paths['/v1/mos/energy-arb/utility-price'].post
$.paths['/v1/mos/energy-arb/recommendations/{site_did}'].get
$.paths['/v1/mos/energy-arb/billing/cycle'].post

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 Mos Energy Arb API
  version: 1.0.0
extends: openapi/thehiveryiq-com-mos-energy-arb-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/mos/energy-arb/utility-price'].post
  update:
    x-apievangelist-phrasing:
      intent: Push a mining site's electricity tariff
      effect: write
      questions:
      - How do I report my facility's current $/kWh rate and hashrate?
      - Can I set when a pushed utility price takes effect?
      instructions:
      - text: Push rate {rate} $/kWh, {kwh} kWh/hour, {hashrate} TH/s for site {site_did}.
        slots:
          rate: requestBody.rate_usd_per_kwh
          kwh: requestBody.kwh_per_hour
          hashrate: requestBody.hashrate_th_s
          site_did: requestBody.site_did
      - text: 'Record a utility price for {site_did} effective {effective_ts}: {rate} $/kWh at {kwh} kWh/hour and {hashrate} TH/s.'
        slots:
          site_did: requestBody.site_did
          effective_ts: requestBody.effective_ts
          rate: requestBody.rate_usd_per_kwh
          kwh: requestBody.kwh_per_hour
          hashrate: requestBody.hashrate_th_s
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mos/energy-arb/recommendations/{site_did}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get mine, throttle or sell-forward advice
      effect: read
      questions:
      - Should my mining site keep mining, throttle or front-load given power prices?
      - What 30-day savings would following the recommendations bring?
      instructions:
      - text: Get energy arbitrage recommendations for site {site_did}.
        slots:
          site_did: path.site_did
      - text: Tell me whether site {site_did} should throttle right now.
        slots:
          site_did: path.site_did
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/mos/energy-arb/billing/cycle'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the monthly savings billing cycle
      effect: write
      questions:
      - How are the 20%-of-savings invoices generated each month?
      - Does the billing cycle actually charge sites or only record invoices?
      instructions:
      - text: Run the energy arb billing cycle for {billing_month}.
        slots:
          billing_month: requestBody.billing_month
      - text: Dry-run invoices for {billing_month} with dry_run {dry_run}.
        slots:
          billing_month: requestBody.billing_month
          dry_run: requestBody.dry_run
      method: generated
      generated: '2026-09-26'